Constants

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.

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

List of functions we forbid to use.

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

List of module metadata we forbid to use.

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

List of variable names we forbid to use.

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

List of magic methods that are forbiden to use.

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

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.

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

List of blacklisted module names:

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

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”: