PhilippRisius / pytest_nbgrader

80%

Build Type

push

github

Committed by web-flow

Commit Message

Chore/typing and exports (#36)

* feat: add type annotations, __all__ exports, and fix has_import

Part A — Fix has_import and file_contents assertions:
- Add missing `outputs` parameter to match _log wrapper contract
- Replace nonexistent `case.return_object` with `outputs[0][0]`
- Fix relative_to(cwd) crash for stdlib modules via _resolve_origin helper
- Fix inconsistent return tuple lengths (all failures now 3-element)
- Update TestHasImport tests to use standard pipeline (not __wrapped__)
- Add tests for stdlib imports and empty outputs

Part B — Add __all__ exports to all 9 source modules:
- Defines the public API explicitly for each module
- Keeps _log, _SENTINEL, logger as private internals

Part C — Add type annotations to all 9 source modules:
- Add `from __future__ import annotations` to all modules
- Annotate all function signatures, class attributes, and nested helpers
- Define _AssertionResult type alias in assertions.py
- Fix `callable` (builtin) to `Callable` (collections.abc) in prerequisites.py
- Type Timer, TestCase.timing, format_result, execute dispatches in cases.py
- Type TemporarySymlink/TemporarySymlinks with types.ModuleType in runner.py
- Type all pytest hooks and fixtures in conftest.py

All 213 tests pass. All pre-commit hooks pass.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* chore: update mypy override comment for source modules

Annotations are in place; strict enforcement deferred due to
pre-existing dynamic patterns (77 errors, mostly bare generics
and nullable attribute access). The ignore_errors stays for now.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Philipp Risius <philipp.e.risius@theo.physik.uni-giessen.de>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>

Coverage Stats

61 of 99 new or added lines in 9 files covered. (61.62%)

3 existing lines in 3 files now uncovered.

459 of 571 relevant lines covered (80.39%)

2.41 hits per line