Glossary of Terms Used in Flake8 Documentation

check

A piece of logic that corresponds to an error code. A check maybe a style check (e.g., check the length of a given line againstthe user configured maximum) or a lint check (e.g., checking forunused imports) or some other check as defined by a plugin.

class

error class

A larger grouping of relatederror codes. For example,W503 andW504 are two codes related to whitespace.W50would be the most specific class of codes relating to whitespace.W would be the warning class that subsumes all whitespaceerrors.

error

error code

violation

The symbol associated with a specificcheck. For example,pycodestyle implementschecks that look for whitespacearound binary operators and will either return an error code ofW503 orW504.

formatter

Aplugin that augments the output ofFlake8 when passedtoflake8--format.

mccabe

The projectFlake8 depends on to calculate the McCabe complexityof a unit of code (e.g., a function). This uses theCclass oferror codes.

plugin

A package that is typically installed from PyPI to augment thebehaviour ofFlake8 either through adding one or more additionalchecks or providing additionalformatters.

pycodestyle

The projectFlake8 depends on to provide style enforcement.pycodestyle implementschecks forPEP 8. This uses theE andWclasses oferror codes.

pyflakes

The projectFlake8 depends on to lint files (check for unusedimports, variables, etc.). This uses theFclass oferror codes reported byFlake8.

warning

Typically theW class oferror codes from pycodestyle.