silence-lint-error 1.5.0

silence linting errors by adding ignore/fixme comments

silence-lint-error

Silent linting errors by adding ignore or fixme comments.

This tool currently works with:

• fixit
• flake8 (silence only)
• mypy (silence only)
• ruff
• semgrep (silence only)

Usage

Install with pip:

python -m pip install silence-lint-error

You must also install the linting tool you wish to use in the same virtual environment.

silence linting errors

Find linting errors and add the ignore or fixme comments as applicable.

For example, to add lint-fixme: CollapseIsinstanceChecks comments to ignore the fixit.rules:CollapseIsinstanceChecks rule from fixit, run:

silence-lint-error fixit fixit.rules:CollapseIsinstanceChecks path/to/files/ path/to/more/files/

To add noqa: F401 comments to ignore the F401 rule in flake8, run:

silence-lint-error flake8 F401 path/to/files/ path/to/more/files/

To add noqa: F401 comments to ignore the F401 rule in ruff, run:

silence-lint-error ruff F401 path/to/files/ path/to/more/files/

To add nosemgrep: python.lang.best-practice.sleep.arbitrary-sleep comments to ignore the python.lang.best-practice.sleep.arbitrary-sleep rule in semgrep, run:

SEMGREP_RULES=r/python silence-lint-error semgrep python.lang.best-practice.sleep.arbitrary-sleep path/to/files/ path/to/more/files/

N.B. The rules must be configured in an environment variable. For more information about configuring semgrep rules, see the --config entry in the semgrep documentation

To add type: ignore comments to ignore the truthy-bool error from mypy, run:

silence-lint-error mypy truthy-bool path/to/files/ path/to/more/files/

fix silenced errors

If there is an auto-fix for a linting error, you can remove the ignore or fixme comments and apply the auto-fix.

For example, to remove all lint-fixme: CollapseIsinstanceChecks comments and apply the auto-fix for that rule, run:

fix-silenced-error fixit fixit.rules:CollapseIsinstanceChecks path/to/files/ path/to/more/files/

To remove noqa: F401 comments and apply the auto-fix for that rule, run:

fix-silenced-error ruff F401 path/to/files/ path/to/more/files/

Rationale

When adding a new rule (or enabling more rules) for a linter on a large code-base, fixing the existing violations can be too large a task to do quickly. However, starting to check the rule sooner will prevent new violations from being introduced.

Ignoring existing violations is a quick way to allow new rules to be enabled. You can then burn down those existing violations over time.

This tool makes it easy to find and ignore all current violations of a rule so that it can be enabled.