Violations¶
Contains detailed technical information about violation internals.
Violations API¶
Violation for |
|
Violation for |
|
Violation for |
|
Violation for cases where there's no associated nodes. |
Violation cannot have more than one base class. See Tutorial for more information about choosing a correct base class.
Conventions¶
Each violation class name should end with “Violation”
Each violation must have a long docstring with full description
Each violation must have “Reasoning” and “Solution” sections
Each violation must have “versionadded” policy
Each violation should have an example with correct and wrong usages
If violation error template should have a parameter it should be the last part of the text:
: {0}
Deprecating a violation¶
When you want to mark some violation as deprecated,
then assign deprecated
boolean flag to it:
@final
class SomeViolation(ASTViolation):
deprecated = True
Reference¶
- ErrorNode¶
General type for all possible nodes where error happens.
alias of
Optional
[Union
[_ast.AST
,tokenize.TokenInfo
]]
- ErrorCallback¶
We use this type to define helper classes with callbacks to add violations.
alias of
Callable
[[BaseViolation
],None
]
- class ViolationPostfixes(value)[source]¶
Bases:
enum.Enum
String values of postfixes used for violation baselines.
- bigger_than = ' > {0}'¶
- less_than = ' < {0}'¶
- class BaseViolation(node, text=None, baseline=None)[source]¶
Bases:
object
Abstract base class for all style violations.
It basically just defines how to create any error and how to format this error later on.
Each subclass must define
error_template
andcode
fields.- error_template¶
message that will be shown to user after formatting.
- Type
ClassVar[str]
- code¶
unique violation number. Used to identify the violation.
- Type
ClassVar[int]
- previous_codes¶
just a documentation thing to track changes in time.
- Type
ClassVar[Set[int]]
- deprecated¶
indicates that this violation will be removed soon.
- Type
ClassVar[bool]
- postfix_template¶
indicates message that we show at the very end.
- Type
ClassVar[wemake_python_styleguide.violations.base.ViolationPostfixes]
- error_template: ClassVar[str]¶
- code: ClassVar[int]¶
- previous_codes: ClassVar[Set[int]]¶
- deprecated: ClassVar[bool] = False¶
- postfix_template: ClassVar[wemake_python_styleguide.violations.base.ViolationPostfixes] = ' > {0}'¶
- class ASTViolation(node, text=None, baseline=None)[source]¶
Bases:
wemake_python_styleguide.violations.base._BaseASTViolation
Violation for
ast
based style visitors.
- class MaybeASTViolation(node=None, text=None, baseline=None)[source]¶
Bases:
wemake_python_styleguide.violations.base._BaseASTViolation
Violation for
ast
and modules visitors.Is used for violations that share the same rule for nodes and module names. Is wildly used for naming rules.
- class TokenizeViolation(node, text=None, baseline=None)[source]¶
Bases:
wemake_python_styleguide.violations.base.BaseViolation
Violation for
tokenize
based visitors.
- class SimpleViolation(node=None, text=None, baseline=None)[source]¶
Bases:
wemake_python_styleguide.violations.base.BaseViolation
Violation for cases where there’s no associated nodes.