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

Installation

pip install flake8-pytest-style

Configuration

The plugin has the following configuration options:

pytest-fixture-no-parentheses — see PT001
pytest-parametrize-names-type — see PT006
pytest-parametrize-values-type — see PT007
pytest-parametrize-values-row-type — see PT007
pytest-raises-require-match-for — see PT011

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.2.3 - 2020-08-06

update flake8-plugin-utils dependency to fix encoding problems on Windows

1.2.2 - 2020-07-23

fix PT004/PT005 inspecting returns of nested functions

1.2.1 - 2020-06-15

fix PT021 for factory fixtures (#46)

1.2.0 - 2020-06-12

support scoped mocker fixtures from pytest-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 and pytest-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 from pytest)

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

add PT010 and PT011 (checks for pytest.raises parameters)

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

Download files

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

Source Distribution

flake8-pytest-style-1.2.3.tar.gz (14.0 kB view details)

Uploaded Aug 6, 2020 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

flake8_pytest_style-1.2.3-py3-none-any.whl (16.3 kB view details)

Uploaded Aug 6, 2020 Python 3

File details

Details for the file flake8-pytest-style-1.2.3.tar.gz.

File metadata

Download URL: flake8-pytest-style-1.2.3.tar.gz
Upload date: Aug 6, 2020
Size: 14.0 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: poetry/1.0.10 CPython/3.8.0 Linux/4.15.0-1077-gcp

File hashes

Hashes for flake8-pytest-style-1.2.3.tar.gz
Algorithm	Hash digest
SHA256	`48e5ed79ab33846112331bbf51353c568d8a5f515de49c6cd9dfe5fecdcaa6f3`
MD5	`6de0a23722f03f99d726ab7b436374e6`
BLAKE2b-256	`9efa51c864d83abfdad20824689490281be3f2bb75ff83bd36e8ec12cca4f388`

See more details on using hashes here.

File details

Details for the file flake8_pytest_style-1.2.3-py3-none-any.whl.

File metadata

Download URL: flake8_pytest_style-1.2.3-py3-none-any.whl
Upload date: Aug 6, 2020
Size: 16.3 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: poetry/1.0.10 CPython/3.8.0 Linux/4.15.0-1077-gcp

File hashes

Hashes for flake8_pytest_style-1.2.3-py3-none-any.whl
Algorithm	Hash digest
SHA256	`fa6e8706b814b1eedf8f7aa62e26bfc03d0e5178a25d828218165be6c8e52570`
MD5	`842e802857fcc09a52f2764323990b21`
BLAKE2b-256	`8247f808b6309d95ca43ebf8d5b539e0a6bb852e082d7461c5899dd31957ef96`