module documentation

A collection of typing utilities.

Class ErrorDescriptionDict Represents data about errors collected during checking of a module.
Class ExtraMessageOptions All allowed keys in the extra options for message definitions.
Class FileItem Represents data about a file handled by pylint.
Class GetProjectCallable Undocumented
Class ManagedMessage Tuple with information about a managed message of the linter.
Class MessageLocationTuple Tuple with information about the location of a to-be-displayed message.
Class ModuleDescriptionDict Represents data about a checked module.
Type Alias DirectoryNamespaceDict Undocumented
Type Alias MessageDefinitionTuple Undocumented
Type Alias MessageTypesFullName All possible message categories.
Type Alias OptionDict Undocumented
Type Alias Options Undocumented
Type Alias ReportsCallable Callable to create a report.
DirectoryNamespaceDict = (source)

Undocumented

Value
Dict[Path, Tuple[argparse.Namespace, 'DirectoryNamespaceDict']]
MessageDefinitionTuple = (source)

Undocumented

Value
Union[Tuple[str, str, str], Tuple[str, str, str, ExtraMessageOptions]]
MessageTypesFullName = (source)

All possible message categories.

Value
Literal['convention',
        'error',
        'fatal',
        'info',
        'refactor',
        'statement',
        'warning']
OptionDict = (source)

Undocumented

Value
Dict[str,
     Union[None,
           str,
           bool,
           int,
           Pattern[str],
           Iterable[Union[str, int, Pattern[str]]],
...

Undocumented

Value
Tuple[Tuple[str, OptionDict], ...]
ReportsCallable = (source)

Callable to create a report.

Value
Callable[['Section', 'LinterStats', Optional['LinterStats']], None]