Pylint Per-File Ignores Plugin

3.2.1 · active · verified Tue Apr 14

A Pylint plugin designed to enable granular control over Pylint error codes, allowing specific messages to be ignored per file or directory pattern. It provides a flexible alternative to littering code with `# pylint: disable` comments. This library is actively maintained, with its current version being 3.2.1.

Warnings

breaking Prior to version 2.0.0, file patterns used regular expressions. From version 2.0.0 onwards, patterns are matched using globs. Existing configurations from older versions must be reviewed and updated to use glob syntax.
Fix: Review all `per-file-ignores` patterns in your Pylint configuration and convert any regex patterns to glob patterns if upgrading to v2.0.0 or newer. For example, a regex `.*_test\.py` might become a glob `*_test.py` or `/tests/*.py`.
gotcha The plugin is enabled and configured via Pylint's configuration files (e.g., `pyproject.toml`, `.pylintrc`, `setup.cfg`) by adding it to `load-plugins` and defining rules under `per-file-ignores`. It's not a Python module meant for `import` statements in your code.
Fix: Ensure the plugin is activated by correctly adding `pylint_per_file_ignores` to the `load-plugins` list within your chosen Pylint configuration file, and define ignore rules in the designated `per-file-ignores` section.
gotcha Pylint's native `--ignore` option might not work as expected with directories, especially when Pylint is invoked on individual files (e.g., by pre-commit hooks or IDEs). This plugin specifically addresses per-file/pattern ignoring when `--ignore` falls short.
Fix: Leverage `pylint-per-file-ignores` for granular control over file and directory patterns. Ensure your `load-plugins` is correctly configured so the plugin can intercept and apply ignore rules before Pylint processes files.

Install

pip install pylint-per-file-ignores Install with pip

Imports

pylint_per_file_ignores

This plugin is loaded via Pylint's configuration, not directly imported into Python code. Add 'pylint_per_file_ignores' to the 'load-plugins' list in your Pylint configuration file.

The plugin extends Pylint's functionality at runtime through configuration, it does not expose Python symbols for direct import into user scripts.

Quickstart

To quickly enable `pylint-per-file-ignores`, first install it, then add `pylint_per_file_ignores` to the `load-plugins` section of your Pylint configuration (e.g., `pyproject.toml`, `.pylintrc`, or `setup.cfg`). Finally, define your file patterns and corresponding ignored message codes under the `per-file-ignores` section. This example uses `pyproject.toml`.

# pyproject.toml
[tool.pylint.main]
load-plugins = [
    "pylint_per_file_ignores",
]

[tool.pylint.'messages control']
per-file-ignores = [
    "/tests/*:missing-function-docstring,C0115",
    "/src/legacy_code.py:W0621,W0240,E0001"
]

view raw JSON →