Derived from the pep8-naming linter.
What it does#
Checks for class methods that use a name other than
cls for their
Why is this bad?#
PEP 8 recommends the use of
cls as the first argument for all class
clsfor the first argument to class methods.
If a function argument’s name clashes with a reserved keyword, it is generally better to append a single trailing underscore rather than use an abbreviation or spelling corruption. Thus
class_is better than
clss. (Perhaps better is to avoid such clashes by using a synonym.)
Names can be excluded from this rule using the
pep8-naming.extend-ignore-names configuration options. For example,
to allow the use of
klass as the first argument to class methods, set
pep8-naming.extend-ignore-names option to