Skip to main content

Run type checkers on specified test files

Project description

pytest-typechecker

this is a plugin for pytest that allows you to create tests that verify how a type checker responds to your code.

This currently supports these type checkers:

  • pyright
  • mypy

File name format

this plugin looks for files starting with test and ending with types.py or types_xfail.py. for example test_something_types.py

global xfail

if you want to mark the hole test as xfail end it with types_xfail.py, for example.

# test_wrong_types_xfail.py

x: 123 = "abc"
y: str = 123

Only run specific checkers

if you include the name of a checker with _ around it only those checkers will be run. for example test_recursion_pyright_types.py

xfail specific checkers

if you provide a x before the checker name, it will be run in xfail mode. for example test_recursion_xmypy_types.py will run all checkers, but mark the mypy one as xfail

if you only want to run mypy and have it be xfail use this workaround: test_recursion_mypy_types_xfail.py

this can be combined, for example test_recursion_pyright_xmypy_types.py will run only pyright and mypy, but run mypy in xfail mode.

dont run specific checkers

if you provide a n before the checker name, it will not be run. for example test_recursion_nmypy_types.py will run all checkers, except mypy.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest_typechecker-0.3.1.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

pytest_typechecker-0.3.1-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

Details for the file pytest_typechecker-0.3.1.tar.gz.

File metadata

  • Download URL: pytest_typechecker-0.3.1.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.2 Linux/5.10.16.3-microsoft-standard-WSL2

File hashes

Hashes for pytest_typechecker-0.3.1.tar.gz
Algorithm Hash digest
SHA256 71ab9d6df2d613a3f9040b50b86390548c1bab5996dd71a99e4b6a3e991159e2
MD5 d510c38aa0925fc40f284eb0a431039e
BLAKE2b-256 e3ea36f4b06b6cff2e07e0cdfcaf4ef689063cecee978f221dafbc9faf4edd1b

See more details on using hashes here.

File details

Details for the file pytest_typechecker-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: pytest_typechecker-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 3.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.2 Linux/5.10.16.3-microsoft-standard-WSL2

File hashes

Hashes for pytest_typechecker-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cd499d7edc306e59af9f063d530c4b8924141da3d2fdad41b0e02bb51eb3f2ee
MD5 c040f13bb67ecdcb790b0ef9bdce8a1a
BLAKE2b-256 2dc0bcf999c81ec6c8b1b6fc35e54ce60c63faa7978126b138f59a86abaa2193

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page