pytest-mypy-testing — Plugin to test mypy output with pytest
pytest-mypy-testing provides a pytest plugin to test that mypy produces a given output. As mypy can be told to display the type of an expression this allows us to check mypys type interference.
Installation
python -m pip install pytest-mypy-testing
The Python distribution package contains an entry point so that the plugin is automatically discovered by pytest. To disable the plugin when it is installed , you can use the pytest command line option -p no:mypy-testing.
Writing Mypy Output Test Cases
A mypy test case is a top-level functions decorated with @pytest.mark.mypy_testing in a file named *.mypy-testing or in a pytest test module. pytest-mypy-testing follows the pytest logic in identifying test modules and respects the python_files config value.
Note that pytest-mypy-testing uses the Python ast module to parse candidate files and does not import any file, i.e., the decorator must be exactly named @pytest.mark.mypy_testing.
In a pytest test module file you may combine both regular pytest test functions and mypy test functions. A single function can be both.
Example: A simple mypy test case could look like this:
@pytest.mark.mypy_testing
def mypy_test_invalid_assignment() -> None:
foo = "abc"
foo = 123 # E: Incompatible types in assignment (expression has type "int", variable has type "str")
The plugin runs mypy for every file containing at least one mypy test case. The mypy output is then compared to special Python comments in the file:
# N: <msg>- we expect a mypy note message# W: <msg>- we expect a mypy warning message# E: <msg>- we expect a mypy error message# R: <msg>- we expect a mypy note messageRevealed type is '<msg>'. This is useful to easily checkreveal_typeoutput:@pytest.mark.mypy_testing def mypy_use_reveal_type(): reveal_type(123) # N: Revealed type is 'Literal[123]?' reveal_type(456) # R: Literal[456]?
Skipping and Expected Failures
Mypy test case functions can be decorated with @pytest.mark.skip and @pytest.mark.xfail to mark them as to-be-skipped and as expected-to-fail, respectively. As with the @pytest.mark.mypy_testing mark, the names must match exactly as the decorators are extracted from the ast.
Development
- Create and activate a Python virtual environment.
- Install development dependencies by calling
python -m pip install -U -r requirements.txt. - Start developing.
- To run all tests with tox, Python 3.6, 3.7 and 3.8 must be available. You might want to look into using pyenv.
Changelog
v0.0.7
- Fix
PYTEST_VERSION_INFO- by @blueyed (#8) - Always pass
--check-untyped-defsto mypy (#11) - Respect pytest config
python_fileswhen identifying pytest test modules (#12)
v0.0.6 - add pytest 5.4 support
- Update the plugin to work with pytest 5.4 (#7)
v0.0.5 - CI improvements
- Make invoke tasks work (partially) on Windows (#6)
- Add an invoke task to run tox environments by selecting globs (e.g.,
inv tox -e py-*) (#6) - Use coverage directly for code coverage to get more consistent parallel run results (#6)
- Use flit fork dflit to make packaging work with
LICENSESdirectory (#6) - Bump dependencies (#6)
2 Nov 21, 2021
1.9k Dec 30, 2022
10 Jul 21, 2022
909 Dec 15, 2022
218 Jan 03, 2023
4 Sep 22, 2022
14 Oct 06, 2022
74 Dec 31, 2022
2.1k Jan 01, 2023
39 Nov 18, 2022
402 Jan 06, 2023
3 Dec 15, 2022
2 Oct 07, 2022
62 Oct 10, 2022
1 Aug 05, 2021
3.5k Jan 04, 2023
3 Sep 01, 2022
4.1k Nov 30, 2022
1.1k Dec 28, 2022
31 Apr 12, 2022