This module contains list of white- and black-listed python members.

It contains lists of keywords and built-in functions we discourage to use. It also contains some exceptions that we allow to use in our codebase.

FUNCTIONS_BLACKLIST = frozenset({'help', 'credits', 'globals', 'locals', 'vars', 'exec', 'compile', 'delattr', 'staticmethod', 'input', 'copyright', 'quit', '__import__', 'exit', 'dir', 'eval', 'hasattr'})

List of functions we forbid to use.

MODULE_METADATA_VARIABLES_BLACKLIST = frozenset({'__version__', '__about__', '__all__', '__author__'})

List of module metadata we forbid to use.

VARIABLE_NAMES_BLACKLIST = frozenset({'objs', 'false', 'bar', 'content', 'result', 'value', 'handle', 'variable', 'info', 'parameters', 'true', 'val', 'no', 'values', 'obj', 'objects', 'items', 'do', 'params', 'var', 'results', 'vars', 'contents', 'baz', 'file', 'some', 'foo', 'vals', 'item', 'data', 'handler'})

List of variable names we forbid to use.

SPECIAL_ARGUMENT_NAMES_WHITELIST = frozenset({'mcs', 'cls', 'self'})

List of special names that are used only as first argument in methods.

MAGIC_METHODS_BLACKLIST = frozenset({'__del__', '__delattr__', '__delitem__', '__dir__', '__delete__'})

List of magic methods that are forbidden to use.

NESTED_CLASSES_WHITELIST = frozenset({'Params', 'Meta'})

List of nested classes’ names we allow to use.

NESTED_FUNCTIONS_WHITELIST = frozenset({'decorator', 'factory'})

List of nested functions’ names we allow to use.

FUTURE_IMPORTS_WHITELIST = frozenset({'generator_stop', 'annotations'})

List of allowed __future__ imports.

MODULE_NAMES_BLACKLIST = frozenset({'util', 'helpers', 'utilities', 'utils'})

List of blacklisted module names.

MAGIC_MODULE_NAMES_WHITELIST = frozenset({'__init__', '__main__'})

List of allowed module magic names.

MODULE_NAME_PATTERN = re.compile('^_?_?[a-z][a-z\\d_]+[a-z\\d](__)?$')

Regex pattern to name modules.

MAGIC_NUMBERS_WHITELIST = frozenset({0.5, 1024, 100, 1000, 24, 60})

Common numbers that are allowed to be used without being called “magic”.


Maximum amount of # noqa comments per module.