Skip to content
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.

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

Add per-file-ignores mention in violations.rst #1914

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/source/user/violations.rst
Expand Up @@ -136,6 +136,38 @@ the errors in that file will show up without having to modify our
configuration. Both exist so we can choose which is better for us.


Ignoring Violations in Specific Files
-------------------------------------

If we want to ignore one or more violation codes for certain files, you can
use the :option:`flake8 --per-file-ignores` on either the command-line
or in your configuration file.

.. prompt:: bash

flake8 --per-file-ignores='project/test.py:F841 setup.py:E121'
flake8 --per-file-ignores='tests/*:F841,D setup.py:E121'

.. note::

While most options in Flake8 use commas to separate values, this option allows
multiple violation codes to be specified per file with commas so to specify
multiple file mappings use spaces to delimit them.

Paciupa marked this conversation as resolved.
Show resolved Hide resolved
We can also specify it in config file:

.. code-block:: ini

per-file-ignores =
project/test.py:F841
tests/*:F841,D
setup.py:E121
other_project/*:W9

Syntax is similar with :option:`flake8 --exclude` for files
and :option:`flake8 --ignore` for errors.



Selecting Violations with Flake8
================================
Expand Down