Skip to main content

Ignore individual error codes per file with flake8

Project description

flake8-per-file-ignores

Build Status Pypi Entry

This flake8 extension has been discontinued in favour of the per-file-ignores option built into flake8 3.7.0 and above. But be aware that the built-in option uses different syntax.

An extension for flake8 that lets you configure (out-of-source) individual error codes to be ignored per file.

This is mostly useful when dealing with legacy code, so that you don't have to ignore any existing error globally, but get the benefits of all checks in new files, while you avoid introducing new kind of errors in existing files.

The advantage over inline # noqa comments is, that it doesn't clutter your source files or even requires touching them.

Installation

pip install flake8-per-file-ignores

Configuration

You can can use following configuration syntax in any configuration file considered by flake8:

[flake8]
per-file-ignores =
  <filename>: <error>[,<error>[,...]]
  [...]
  • filename is the filename, or if starting with a slash, the full path relative to the directory flake8 is running from, of the script that is subject to the ignores. It can also be a glob pattern, but note (just like with the glob module or in UNIX shells), * doesn't match accross directory boundaries, however, you can use ** in order to match recursively.
  • error has the same semantics as the --ignore command line option.

If an ignored error no longer occurs for a given file it will trigger an X100 error to make you progressively reduce the number of ignores as legacy code gets rewritten or removed.

For an example see the test folder.

Project details


Download files

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

Source Distribution

flake8-per-file-ignores-0.8.1.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

flake8_per_file_ignores-0.8.1-py2.py3-none-any.whl (4.9 kB view details)

Uploaded Python 2Python 3

File details

Details for the file flake8-per-file-ignores-0.8.1.tar.gz.

File metadata

  • Download URL: flake8-per-file-ignores-0.8.1.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for flake8-per-file-ignores-0.8.1.tar.gz
Algorithm Hash digest
SHA256 aeac75cc29425b3b4b73eaa92941939dbe16b83f689381ebaef1471982fdcb47
MD5 ddb59f1f7ef8e9367b53a6d9ffd000c4
BLAKE2b-256 a6b9dfb8c7e0a150a1959112b38ad5bc9b3d275e18fbaeda4e620eb23a4724ba

See more details on using hashes here.

File details

Details for the file flake8_per_file_ignores-0.8.1-py2.py3-none-any.whl.

File metadata

  • Download URL: flake8_per_file_ignores-0.8.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for flake8_per_file_ignores-0.8.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2ee2b61e23cc84e7e76b8f7b2ffc135ec0c3331cba776bb5c03ab5d562b0f40c
MD5 44ab0de282453ceb54f3c97db6d80350
BLAKE2b-256 3ca4ff59b8b92f65185f561758a0309817dcdd13dcd095e415fda8a2b4075cac

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page