pytest plugin for writing tests for mypy plugins
Project description
pytest plugin for testing mypy types, stubs, and plugins
Installation
pip install pytest-mypy-plugins
Usage
Running
Plugin, after installation, is automatically picked up by pytest therefore it is sufficient to
just execute:
pytest
What is a test case?
In general each test case is just an element in an array written in a properly formatted YAML file.
On top of that, each case must comply to following types:
| Property | Type | Description |
|---|---|---|
case |
str |
Name of the test case, complies to [a-zA-Z0-9] pattern |
main |
str |
Portion of the code as if written in .py file |
files |
Optional[List[File]]=[]* |
List of extra files to simulate imports if needed |
disable_cache |
Optional[bool]=False |
Set to true disables mypy caching |
mypy_config |
Optional[Dict[str, Union[str, int, bool, float]]]={} |
Inline mypy configuration, passed directly to mypy as --config-file option |
env |
Optional[Dict[str, str]]={} |
Environmental variables to be provided inside of test run |
parametrized |
Optional[List[Parameter]]=[]* |
List of parameters, similar to @pytest.mark.parametrize |
skip |
str |
Expression evaluated with following globals set: sys, os, pytest and platform |
Appendix to pseudo types used above:
class File:
path: str
content: Optional[str] = None
Parameter = Mapping[str, Any]
Implementation notes:
mainmust be non-empty string that evaluates to valid Python code,contentof each of extra files must evaluate to valid Python code,parametrizedentries must all be the objects of the same type. It simply means that each entry must have exact same set of keys,skip- an expression set inskipis passed directly intoeval. It is advised to take a peek and learn about howevalworks.
Example
1. Inline type expectations
# typesafety/test_request.yml
- case: request_object_has_user_of_type_auth_user_model
main: |
from django.http.request import HttpRequest
reveal_type(HttpRequest().user) # N: Revealed type is 'myapp.models.MyUser'
# check that other fields work ok
reveal_type(HttpRequest().method) # N: Revealed type is 'Union[builtins.str, None]'
files:
- path: myapp/__init__.py
- path: myapp/models.py
content: |
from django.db import models
class MyUser(models.Model):
pass
2. @parametrized
- case: with_params
parametrized:
- val: 1
rt: builtins.int
- val: 1.0
rt: builtins.float
main: |
reveal_type({[ val }}) # N: Revealed type is '{{ rt }}'
3. Longer type expectations
- case: with_out
main: |
reveal_type('str')
out: |
main:1: note: Revealed type is 'builtins.str'
Options
mypy-tests:
--mypy-testing-base=MYPY_TESTING_BASE
Base directory for tests to use
--mypy-ini-file=MYPY_INI_FILE
Which .ini file to use as a default config for tests
--mypy-same-process
Now, to help with various issues in django-stubs, it runs every single test in the subprocess mypy call.
Some debuggers cannot attach to subprocess, so enable this flag to make mypy check happen in the same process.
(Could cause cache issues)
Further reading
License
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pytest-mypy-plugins-1.5.0.tar.gz
(13.9 kB
view details)
Built Distribution
File details
Details for the file pytest-mypy-plugins-1.5.0.tar.gz.
File metadata
- Download URL: pytest-mypy-plugins-1.5.0.tar.gz
- Upload date:
- Size: 13.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bd76959cbd34765ad350bac7c0c923276dff59ffebbd66bb4becc95baa0e600f |
|
| MD5 | 08288a61e5d9cca2edc9e2f231500827 |
|
| BLAKE2b-256 | 86618dc7d36c60a0386a1454e225cc1fc98fde5760270681b3e1f80c219b9a84 |
File details
Details for the file pytest_mypy_plugins-1.5.0-py3-none-any.whl.
File metadata
- Download URL: pytest_mypy_plugins-1.5.0-py3-none-any.whl
- Upload date:
- Size: 14.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ce569074d8b9ce8a84cebaf9e7859399f238b1d3fd19dc4643eb41b2d60d7dc4 |
|
| MD5 | 170eb578097502934ba3535d6ec9b338 |
|
| BLAKE2b-256 | 438574512596a7b6389cbc5e1981c0957bafd400b68d499da3855ace150264e3 |
