/pylint-per-file-ignores

A pylint plugin to ignore error codes per file.

Primary LanguagePython

Pylint Per File Ignores 😲

This pylint plugin will enable per-file-ignores in your project!

Install

# w/ poetry
poetry add --dev pylint-per-file-ignores

# w/ pip
pip install pylint-per-file-ignores

Add to Pylint Settings

[tool.pylint.MASTER]
load-plugins=[
    "pylint_per_file_ignores",
    ...
]

Usage

Add list of patterns and codes you would like to ignore.

Using native pylint settings

Section "MESSAGES CONTROL". Examples:

# setup.cfg

[pylint.MESSAGES CONTROL]
per-file-ignores =
  /folder_1/:missing-function-docstring,W0621,W0240,C0115
  file.py:C0116,E0001
# pyproject.toml

[tool.pylint.'MESSAGES CONTROL']
per-file-ignores = [
    "/folder_1/:missing-function-docstring,W0621,W0240,C0115",
    "file.py:C0116,E0001"
]

Using custom pyproject.toml section

For backwards compatibility only. Example:

[tool.pylint-per-file-ignores]
"/folder_1/"="missing-function-docstring,W0621,W0240,C0115"
"file.py"="C0116,E0001"

Thanks

To pylint :) And the plugin pylint-django who produced most of the complex code.

Contributing

This repo uses commitizen and semantic release. Please commit using npm run commit .