Usage

Remember that wemake-python-styleguide is just a flake8 plugin.

Running

To run our linter you will need to run flake8 in any way you like:

flake8 your_module.py
flake8 your_package

See the flake8 docs for options and usage examples.

Golden rule is to run your linter on each commit locally and inside the CI. And to fail the build if there are any style violations.

Ignoring violations

We know that people might not agree with 100% of our rules. But we still want to provide the best experience for all users.

So, you can disable some checks, that you are not ok with. Note: you might accidentally break the consistency of this project, when you disable some checks. We do not officially recommend to do it.

There are three ways to ignore some specific violations:

  1. Inline ignore with # noqa: comment and comma separated violation codes
  2. Command line argument --ignore with comma separated violation codes
  3. Configuration line inside setup.cfg or tox.ini, example

You can ignore:

  1. Whole Z letter, this will completely turn off all our custom checks
  2. Some specific group (naming, complexity, consistency, best practices) with Z and the first number
  3. Some specific violation with the full violation code

We use flake8-per-file-ignore plugin, so it is possible to ignore violations on a per-file bases. It means, that you can have different set of violations ignored for different files.

Read more about ignoring violations in the official docs.

Legacy projects

Introducing this package to a legacy project is almost impossible. Due to strict quality and complexity rules.

But, you still can do several things to integrate this linter step by step:

  1. Fix consistency, naming and best-practices violations, they are the easiest to clean up.
  2. Per-file ignore complexity checks that are failing for your project. Sometimes it is possible to rewrite several parts of your code, but generally complexity rules are the hardest to fix.
  3. Use boyscout rule: always leave your code better than you found it.

You can also only lint recently changed files.

Integrations

We leverage all the existing flake8 infrastructure. There are different integrations for your workflow.

Hooks

  • pytest-flake8 to run style checks alongside with tests (recommended)
  • pre-commit to run flake8 before all commits locally

Extras

There are some tools that are out of scope of this linter, however they are super cool. And should definitely be used!

Things we highly recommend to improve your code quality:

  • mypy runs type checks on your python code. Finds tons of issues. Makes your code better, improves you as a programmer. You must use, and tell your friends to use it too
  • layer-linter allows you to define application layers and ensure you do not break that contract. Absolutely must have
  • xenon and radon allow you to automate some code metrics check
  • cohesion tool to measure code cohesion, works for most of the times. We recommend to use it as a reporting tool
  • vulture allows you to find unused code. Has some drawbacks, since there is too many magic in python code. But, it is still very useful tool for the refactoring

Uninstall

We do not recommend to uninstall our linter ;)

But, in case you really have to, we can help you with an advice:

  • use poetry or pipenv, this way all our dependencies will also be removed alongside the main tool
  • if you still use pip, you will have to manually delete all the dependencies which can be found in project’s pyproject.toml