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.2.0.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

pytest_typechecker-0.2.0-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pytest_typechecker-0.2.0.tar.gz
  • Upload date:
  • Size: 3.2 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.2.0.tar.gz
Algorithm Hash digest
SHA256 5edf0492fff63ab74f72e3101672fcceceaee278e49fd3273bb1f59653aa51d5
MD5 dfa87ee6a210596a7f265631ac99a473
BLAKE2b-256 01690d05908a822ef47f5ff41b139af95993fee18bf9cc55e521629bb0e636c4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pytest_typechecker-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 3.6 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8e1dc18ea9f6c2a268bda572804a8326d5eb1f4371e29b7f15f6418eb5b248d0
MD5 7aeaf4da258bf180a345e2ac11147140
BLAKE2b-256 69597fb38f65487ea55ba1c34ce091f630a8b06c3223661a99abe351efd3bb22

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