Flakeheaven

Flakeheaven is a Flake8 wrapper to make it cool.

Some of it's features are:

• Lint md, rst, ipynb, and more.
• Shareable and remote configs.
• Legacy-friendly: ability to get report only about new errors.
• Caching for much better performance.
• Use only specified plugins, not everything installed.
• Make output beautiful.
• pyproject.toml support.
• Check that all required plugins are installed.
• Syntax highlighting in messages and code snippets.
• PyLint integration.
• Remove unused noqa.
• Powerful GitLab support.
• Codes management:
  • Manage codes per plugin.
  • Enable and disable plugins and codes by wildcard.
  • Show codes for installed plugins.
  • Show all messages and codes for a plugin.
  • Allow codes intersection for different plugins.

Installation⚑

pip install flakeheaven

Configuration⚑

Flakeheaven can be configured in pyproject.toml. You can specify any Flake8 options and Flakeheaven-specific parameters.

Plugins⚑

In pyproject.toml you can specify [tool.flakeheaven.plugins] table. It's a list of flake8 plugins and associated to them rules.

Key can be exact plugin name or wildcard template. For example "flake8-commas" or "flake8-*". Flakeheaven will choose the longest match for every plugin if possible. In the previous example, flake8-commas will match to the first pattern, flake8-bandit and flake8-bugbear to the second, and pycodestyle will not match to any pattern.

Value is a list of templates for error codes for this plugin. First symbol in every template must be + (include) or - (exclude). The latest matched pattern wins. For example, ["+*", "-F*", "-E30?", "-E401"] means "Include everything except all checks that starts with F, check from E301 to E310, and E401".

[tool.flakeheaven]
# specify any flake8 options. For example, exclude "example.py":
exclude = ["example.py"]
# make output nice
format = "grouped"
# don't limit yourself
max_line_length = 120
# show line of source code in output
show_source = true

# list of plugins and rules for them
[tool.flakeheaven.plugins]
# include everything in pyflakes except F401
pyflakes = ["+*", "-F401"]
# enable only codes from S100 to S199
flake8-bandit = ["-*", "+S1??"]
# enable everything that starts from `flake8-`
"flake8-*" = ["+*"]
# explicitly disable plugin
flake8-docstrings = ["-*"]

# disable some checks for tests
[tool.flakeheaven.exceptions."tests/"]
pycodestyle = ["-F401"]     # disable a check
pyflakes = ["-*"]           # disable a plugin

# do not disable `pyflakes` for one file in tests
[tool.flakeheaven.exceptions."tests/test_example.py"]
pyflakes = ["+*"]           # enable a plugin

Check a complete list of flake8 extensions.

• flake8-bugbear: Finding likely bugs and design problems in your program. Contains warnings that don't belong in pyflakes and pycodestyle.
• flake8-fixme: Check for FIXME, TODO and other temporary developer notes.
• flake8-debugger: Check for pdb or idbp imports and set traces.
• flake8-mutable: Checks for mutable default arguments anti-pattern.
• flake8-pytest: Check for uses of Django-style assert-statements in tests. So no more self.assertEqual(a, b), but instead assert a == b.
• flake8-pytest-style: Checks common style issues or inconsistencies with pytest-based tests.
• flake8-simplify: Helps you to simplify code.
• flake8-variables-names: Helps to make more readable variables names.
• pep8-naming: Check your code against PEP 8 naming conventions.
• flake8-expression-complexity: Check expression complexity.
• flake8-use-fstring: Checks you're using f-strings.
• flake8-docstrings: adds an extension for the fantastic pydocstyle tool to Flake8.
• flake8-markdown: lints GitHub-style Python code blocks in Markdown files using flake8.
• pylint is a Python static code analysis tool which looks for programming errors, helps enforcing a coding standard, sniffs for code smells and offers simple refactoring suggestions.
• dlint: Encourage best coding practices and helping ensure Python code is secure.
• flake8-aaa: Checks Python tests follow the Arrange-Act-Assert pattern.
• flake8-annotations-complexity: Report on too complex type annotations.
• flake8-annotations: Detects the absence of PEP 3107-style function annotations and PEP 484-style type comments.
• flake8-typing-imports: Checks that typing imports are properly guarded.
• flake8-comprehensions: Help you write better list/set/dict comprehensions.
• flake8-eradicate: find commented out (or so called "dead") code.

Usage⚑

When using Flakeheaven, I frequently use the following commands:

flakeheaven lint

Runs the linter, similar to the flake8 command.

flakeheaven plugins

Lists all the plugins used, and their configuration status.

flakeheaven missed

Shows any plugins that are in the configuration but not installed properly.

flakeheaven code S322

(or any other code) Shows the explanation for that specific warning code.

flakeheaven yesqa

Removes unused codes from # noqa and removes bare noqa that says “ignore everything on this line” as is a bad practice.

Integrations⚑

Flakeheaven checks can be run in:

• In Vim though the ALE plugin.

• Through a pre-commit:

    - repo: https://github.com/flakeheaven/flakeheaven
      rev: master
      hooks:
        - name: Run flakeheaven static analysis tool
          id: flakeheaven
  

• In the CI:

    - name: Test linters
      run: make lint
  

  Assuming you're using a Makefile like the one in my cookiecutter-python-project.

Issues⚑

• ImportError: cannot import name 'MergedConfigParser' from 'flake8.options.config': remove the dependency pin in cookiecutter template and propagate to all projects.

• 'Namespace' object has no attribute 'extended_default_ignore' error: Until it's fixed either use a version below or equal to 3.9.0, or add to your pyproject.toml:

  [tool.flakeheaven]
  extended_default_ignore=[]  # add this
  

  Once it's fixed, remove the patch from the maintained projects.

Troubleshooting⚑

['Namespace' object has no attribute⚑

'extended_default_ignore'](https://githubmemory.com/repo/flakeheaven/flakeheaven/issues/10)

Add to your pyproject.toml:

[tool.flakeheaven]
extended_default_ignore=[]

References⚑

• Git

• Docs

• Using Flake8 and pyproject.toml with Flakeheaven article by Jonathan Bowman