GlossaryΒΆ
First of all, we should speak the same language. Here we collect all the specific terms that are used in this project.
- plugin
- A plugin for
flake8
, developed following official guides. - wemake_python_styleguide
flake8
plugin.Set of rules of how we write
python
code in wemake.services.- checker
flake8
plugin compatible class that is used as an entry point. Entry point and violation codes are defined inpyproject.toml
. This class runs all visitors that exist in our style guide.- visitor
- An object that goes through set of
ast
,tokenize
, or other nodes to find violation of our rules. - violation
Stylistic or semantic error.
We count each violation definition as a strict rule: how should we behave in different situations.
Each violation has its own reasoning, solution, and code examples. Some violations can be configured, some violations contains related constants.