Pytest plugin to check mypy output.
pytest-mypy-testing — Plugin to test mypy output with pytest
pip install pytest-mypy-testing
The Python distribution package contains an entry
so that the plugin is automatically discovered by pytest. To disable
the plugin when it is installed , you can use the pytest command line
Writing Mypy Output Test Cases
A mypy test case is a top-level functions decorated with
@pytest.mark.mypy_testing in a file name
test_*.mypy-testing. Note that we use the Python
ast module to parse
candidate files and do not import any file, i.e., the decorator must
be exactly named
test_*.py file you may combine both regular pytest test
functions and mypy test functions. A single function can even be both.
Example: A simple mypy test case could look like this:
@pytest.mark.mypy_testing def mypy_test_invalid_assginment(): 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 message
Revealed type is '<msg>'. This is useful to easily check
@pytest.mark.mypy_testing def mypy_use_reveal_type(): reveal_type(123) # N: Revealed type is 'Literal?' reveal_type(456) # R: Literal?
Skipping and Expected Failures
Mypy test case functions can be decorated with
@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.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size pytest_mypy_testing-0.0.4-py3-none-any.whl (19.2 kB)||File type Wheel||Python version py3||Upload date||Hashes View hashes|
|Filename, size pytest-mypy-testing-0.0.4.tar.gz (24.0 kB)||File type Source||Python version None||Upload date||Hashes View hashes|
Hashes for pytest_mypy_testing-0.0.4-py3-none-any.whl
Hashes for pytest-mypy-testing-0.0.4.tar.gz