A flake8 plugin checking common style issues or inconsistencies with pytest-based tests.
Project description
flake8-pytest-style
Description
A flake8
plugin checking common style issues or inconsistencies with pytest
-based tests.
Currently the following errors are reported:
Code | Description |
---|---|
PT001 | use @pytest.fixture() over @pytest.fixture (configurable by pytest-fixture-no-parentheses ) |
PT002 | configuration for fixture '{name}' specified via positional args, use kwargs |
PT003 | scope='function' is implied in @pytest.fixture() |
PT004 | fixture '{name}' does not return anything, add leading underscore |
PT005 | fixture '{name}' returns a value, remove leading underscore |
PT006 | wrong name(s) type in @pytest.mark.parametrize, expected {expected_type} (configurable by pytest-parametrize-names-type ) |
PT007 | wrong values type in @pytest.mark.parametrize, expected {expected_type} (configurable by pytest-parametrize-values-type and pytest-parametrize-values-row-type ) |
PT008 | use return_value= instead of patching with lambda |
PT009 | use a regular assert instead of unittest-style '{assertion}' |
PT010 | set the expected exception in pytest.raises() |
PT011 | set the match parameter in pytest.raises({exception}) (configurable by pytest-raises-require-match-for ) |
PT012 | pytest.raises() block should contain a single simple statement |
PT013 | found incorrect import of pytest, use simple 'import pytest' instead |
PT014 | found duplicate test cases {indexes} in @pytest.mark.parametrize |
PT015 | assertion always fails, replace with pytest.fail() |
PT016 | no message passed to pytest.fail() |
PT017 | found assertion on exception {name} in except block, use pytest.raises() instead |
PT018 | assertion should be broken down into multiple parts |
PT019 | fixture {name} without value is injected as parameter, use @pytest.mark.usefixtures instead |
PT020 | @pytest.yield_fixture is deprecated, use @pytest.fixture |
PT021 | use yield instead of request.addfinalizer |
PT022 | no teardown in fixture {name}, use return instead of yield |
PT023 | use @pytest.mark.foo() over @pytest.mark.foo (configurable by pytest-mark-no-parentheses ) |
PT024 | pytest.mark.asyncio is unnecessary for fixtures |
Installation
pip install flake8-pytest-style
Configuration
The plugin has the following configuration options:
pytest-fixture-no-parentheses
— see PT001pytest-parametrize-names-type
— see PT006pytest-parametrize-values-type
— see PT007pytest-parametrize-values-row-type
— see PT007pytest-raises-require-match-for
— see PT011pytest-mark-no-parentheses
— see PT023
For developers
Install deps and setup pre-commit hook
make init
Run linters, autoformat, tests etc.
make format lint test
Bump new version
make bump_major
make bump_minor
make bump_patch
License
MIT
Change Log
Unreleased
...
1.4.0 - 2021-03-14
- add PT023 (checks for parentheses consistency in
pytest.mark
usage) - add PT024 (checks for unnecessary
pytest.mark.asyncio
on fixtures) - fix PT004, PT005 firing on abstract fixtures
- fix PT012 firing on
with
statements containing a singlepass
1.3.0 - 2020-08-30
- add PT022 (checks for
yield
fixtures without teardown)
1.2.3 - 2020-08-06
- update
flake8-plugin-utils
dependency to fix encoding problems on Windows
1.2.2 - 2020-07-23
1.2.1 - 2020-06-15
- fix PT021 for factory fixtures (#46)
1.2.0 - 2020-06-12
- support scoped
mocker
fixtures frompytest-mock
for PT008 - check for positional-only lambda arguments in PT008
- add PT020 (checks for
pytest.yield_fixture
) - add PT021 (checks for
request.addfinalizer
) - add documentation pages for all rules
1.1.1 - 2020-04-17
- fix PT011 not reporting
match=''
as a violation
1.1.0 - 2020-04-14
- add PT015 (checks for
assert False
) - add PT016 (checks for
pytest.fail()
without message) - add PT017 (checks for assertions on exceptions in
except
blocks) - add PT018 (checks for composite assertions)
- add PT019 (checks for fixtures without value injected as parameters)
1.0.0 - 2020-03-26
- add PT014 (checks for duplicate test cases in
@pytest.mark.parametrize
)
0.6.0 - 2020-03-21
- add configuration option
pytest-parametrize-names-type
for PT006 - add configuration options
pytest-parametrize-values-type
andpytest-parametrize-values-row-type
for PT007
0.5.0 - 2020-03-09
- add configuration option
pytest-fixture-no-parentheses
for PT001 - add PT013 (checks for
from
-imports frompytest
)
0.4.0 - 2020-03-09
- add PT012 (checks for multiple statements in
with pytest.raises()
)
0.3.1 - 2020-03-09
- fix default value of
pytest-raises-require-match-for
config option
0.3.0 - 2020-03-09
0.2.0 - 2020-03-01
- add PT009 (ported from flake8-pytest)
0.1.3 - 2019-05-24
- add
yield
fixtures support - fix changelog entry for 0.1.2
0.1.2 - 2019-05-23
- fix parametrize checkers not working in decorators
0.1.1 - 2019-05-23
- update PyPI description
0.1.0 - 2019-05-23
- initial
Project details
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
Built Distribution
Hashes for flake8-pytest-style-1.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f51bf5c8f657ad4b4938bfedb9a5b84fb0885f72ac07b406ebb7f5ea83f8b74e |
|
MD5 | f6421c7cd30244da125c15b5c1931ed7 |
|
BLAKE2b-256 | 8dbb1717235a76467799f7f0c389cbf5c2266fca5e6629f38b8b6c7adbbda41d |
Hashes for flake8_pytest_style-1.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8b6f24b15b28f317eee1bd354f38427007d527774e2ac8ae8b936e6e7eda604 |
|
MD5 | 09b40fd1579fcf04403465e2d056f689 |
|
BLAKE2b-256 | 85bf8fc31bd5350e2462c6500871863a8fab9e6478b832d45dc3229a229a7490 |