Skip to content

add flake8-pytest-style to plugin_list.rst #10939

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 28, 2023
Merged

add flake8-pytest-style to plugin_list.rst #10939

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ce48976
add flake8-pytest-style to plugin_list.rst
sergkim13 Apr 24, 2023
592e0d5
Revert "add flake8-pytest-style to plugin_list.rst"
sergkim13 Apr 27, 2023
eab0b8e
add flake8-pytest-style mention to goodpractices
sergkim13 Apr 27, 2023
ecdcd3a
add disclaimer about flake8-pytest-style
sergkim13 Apr 28, 2023
ebf537f
Slight edits
bluetech Apr 28, 2023
097900d
Update goodpractices.rst
bluetech Apr 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions doc/en/explanation/goodpractices.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,3 +294,20 @@ See also `pypa/setuptools#1684 <https://github.com/pypa/setuptools/issues/1684>`

setuptools intends to
`remove the test command <https://github.com/pypa/setuptools/issues/931>`_.

Checking with flake8-pytest-style
---------------------------------

In order to ensure that pytest is being used correctly in your project,
it can be helpful to use the `flake8-pytest-style <https://github.com/m-burst/flake8-pytest-style>`_ flake8 plugin.

flake8-pytest-style checks for common mistakes and coding style violations in pytest code,
such as incorrect use of fixtures, test function names, and markers.
By using this plugin, you can catch these errors early in the development process
and ensure that your pytest code is consistent and easy to maintain.

A list of the lints detected by flake8-pytest-style can be found on its `PyPI page <https://pypi.org/project/flake8-pytest-style/>`_.

.. note::

flake8-pytest-style is not an official pytest project. Some of the rules enforce certain style choices, such as using `@pytest.fixture()` over `@pytest.fixture`, but you can configure the plugin to fit your preferred style.