mypy.errors.Errors

class documentation

class Errors: (source)

Container for compile errors.

This class generates and keeps tracks of compile errors and the current error context (nested imports).

Method	`__init__`	Undocumented
Method	`add_error_info`	Undocumented
Method	`blocker_module`	Return the module with a blocking error, or None if not possible.
Method	`clear_errors_in_targets`	Remove errors in specific fine-grained targets within a file.
Method	`copy`	Undocumented
Method	`current_module`	Undocumented
Method	`current_target`	Retrieves the current target from the associated scope.
Method	`file_messages`	Return a string list of new error messages from a given file.
Method	`format_messages`	Return a string list that represents the error messages.
Method	`generate_unused_ignore_errors`	Undocumented
Method	`has_many_errors`	Undocumented
Method	`import_context`	Return a copy of the import context.
Method	`initialize`	Undocumented
Method	`is_blockers`	Are the any errors that are blockers?
Method	`is_error_code_enabled`	Undocumented
Method	`is_errors`	Are there any generated messages?
Method	`is_errors_for_file`	Are there any errors for the given file?
Method	`is_ignored_error`	Undocumented
Method	`is_real_errors`	Are there any generated errors (not just notes, for example)?
Method	`most_recent_error_location`	Undocumented
Method	`new_messages`	Return a string list of new error messages.
Method	`num_messages`	Return the number of generated messages.
Method	`raise_error`	Raise a CompileError with the generated messages.
Method	`remove_duplicates`	Remove duplicates from a sorted error list.
Method	`render_messages`	Translate the messages into a sequence of tuples.
Method	`report`	Report message at the given line using the current error context.
Method	`report_hidden_errors`	Undocumented
Method	`reset`	Undocumented
Method	`set_file`	Set the path and module id of the current file.
Method	`set_file_ignored_lines`	Undocumented
Method	`set_ignore_prefix`	Set path prefix that will be removed from all paths.
Method	`set_import_context`	Replace the entire import context with a new value.
Method	`simplify_path`	Undocumented
Method	`sort_messages`	Sort an array of error messages locally by line number.
Method	`targets`	Return a set of all targets that contain errors.
Method	`total_errors`	Undocumented
Instance Variable	`disabled_error_codes`	Undocumented
Instance Variable	`enabled_error_codes`	Undocumented
Instance Variable	`error_info_map`	Undocumented
Instance Variable	`file`	Undocumented
Instance Variable	`flushed_files`	Undocumented
Instance Variable	`function_or_member`	Undocumented
Instance Variable	`ignore_prefix`	Undocumented
Instance Variable	`ignored_files`	Undocumented
Instance Variable	`ignored_lines`	Undocumented
Instance Variable	`import_ctx`	Undocumented
Instance Variable	`many_errors_threshold`	Undocumented
Instance Variable	`only_once_messages`	Undocumented
Instance Variable	`pretty`	Undocumented
Instance Variable	`read_source`	Undocumented
Instance Variable	`scope`	Undocumented
Instance Variable	`seen_import_error`	Undocumented
Instance Variable	`show_absolute_path`	Undocumented
Instance Variable	`show_column_numbers`	Undocumented
Instance Variable	`show_error_codes`	Undocumented
Instance Variable	`show_error_context`	Undocumented
Instance Variable	`target_module`	Undocumented
Instance Variable	`used_ignored_lines`	Undocumented
Method	`_add_error_info`	Undocumented

def __init__(self, show_error_context=False, show_column_numbers=False, show_error_codes=False, pretty=False, read_source=None, show_absolute_path=False, enabled_error_codes=None, disabled_error_codes=None, many_errors_threshold=-1): (source)

Undocumented

Parameters
show_error_context:`bool`	Undocumented
show_column_numbers:`bool`	Undocumented
show_error_codes:`bool`	Undocumented
pretty:`bool`	Undocumented
read_source:`Optional[Callable[[str], Optional[List[str]]]]`	Undocumented
show_absolute_path:`bool`	Undocumented
enabled_error_codes:`Optional[Set[ErrorCode]]`	Undocumented
disabled_error_codes:`Optional[Set[ErrorCode]]`	Undocumented
many_errors_threshold:`int`	Undocumented

def add_error_info(self, info): (source)

Undocumented

Parameters
info:`ErrorInfo`	Undocumented

def blocker_module(self): (source)

Return the module with a blocking error, or None if not possible.

Returns
`Optional[str]`	Undocumented

def clear_errors_in_targets(self, path, targets): (source)

Remove errors in specific fine-grained targets within a file.

Parameters
path:`str`	Undocumented
targets:`Set[str]`	Undocumented

def copy(self): (source)

Undocumented

Returns
`Errors`	Undocumented

def current_module(self): (source)

Undocumented

Returns
`Optional[str]`	Undocumented

def current_target(self): (source)

Retrieves the current target from the associated scope.

If there is no associated scope, use the target module.

Returns
`Optional[str]`	Undocumented

def file_messages(self, path): (source)

Return a string list of new error messages from a given file.

Use a form suitable for displaying to the user.

Parameters
path:`str`	Undocumented
Returns
`List[str]`	Undocumented

def format_messages(self, error_info, source_lines): (source)

Return a string list that represents the error messages.

Use a form suitable for displaying to the user. If self.pretty is True also append a relevant trimmed source code line (only for severity 'error').

Parameters
error_info:`List[ErrorInfo]`	Undocumented
source_lines:`Optional[List[str]]`	Undocumented
Returns
`List[str]`	Undocumented

def generate_unused_ignore_errors(self, file): (source)

Undocumented

Parameters
file:`str`	Undocumented

def has_many_errors(self): (source)

Undocumented

Returns
`bool`	Undocumented

def import_context(self): (source)

Return a copy of the import context.

Returns
`List[Tuple[str, int]]`	Undocumented

def initialize(self): (source)

Undocumented

def is_blockers(self): (source)

Are the any errors that are blockers?

Returns
`bool`	Undocumented

def is_error_code_enabled(self, error_code): (source)

Undocumented

Parameters
error_code:`ErrorCode`	Undocumented
Returns
`bool`	Undocumented

def is_errors(self): (source)

Are there any generated messages?

Returns
`bool`	Undocumented

def is_errors_for_file(self, file): (source)

Are there any errors for the given file?

Parameters
file:`str`	Undocumented
Returns
`bool`	Undocumented

def is_ignored_error(self, line, info, ignores): (source)

Undocumented

Parameters
line:`int`	Undocumented
info:`ErrorInfo`	Undocumented
ignores:`Dict[int, List[str]]`	Undocumented
Returns
`bool`	Undocumented

def is_real_errors(self): (source)

Are there any generated errors (not just notes, for example)?

Returns
`bool`	Undocumented

def most_recent_error_location(self): (source)

Undocumented

Returns
`Tuple[int, int]`	Undocumented

def new_messages(self): (source)

Return a string list of new error messages.

Use a form suitable for displaying to the user. Errors from different files are ordered based on the order in which they first generated an error.

Returns
`List[str]`	Undocumented

def num_messages(self): (source)

Return the number of generated messages.

Returns
`int`	Undocumented

def raise_error(self, use_stdout=True): (source)

Raise a CompileError with the generated messages.

Render the messages suitable for displaying.

Parameters
use_stdout:`bool`	Undocumented

def remove_duplicates(self, errors): (source)

Remove duplicates from a sorted error list.

Parameters
errors:`List[ErrorTuple]`	Undocumented
Returns
`List[ErrorTuple]`	Undocumented

def render_messages(self, errors): (source)

Translate the messages into a sequence of tuples.

Each tuple is of form (path, line, col, severity, message, allow_dups, code). The rendered sequence includes information about error contexts. The path item may be None. If the line item is negative, the line number is not defined for the tuple.

Parameters
errors:`List[ErrorInfo]`	Undocumented
Returns
`List[ErrorTuple]`	Undocumented

def report(self, line, column, message, code=None, *, blocker=False, severity='error', file=None, only_once=False, allow_dups=False, origin_line=None, offset=0, end_line=None): (source)

Report message at the given line using the current error context.

Args:: line: line number of error column: column number of error message: message to report code: error code (defaults to 'misc'; not shown for notes) blocker: if True, don't continue analysis after this error severity: 'error' or 'note' file: if non-None, override current file as context only_once: if True, only report this exact message once per build allow_dups: if True, allow duplicate copies of this message (ignored if only_once) origin_line: if non-None, override current context as origin end_line: if non-None, override current context as end

Parameters
line:`int`	Undocumented
column:`Optional[int]`	Undocumented
message:`str`	Undocumented
code:`Optional[ErrorCode]`	Undocumented
blocker:`bool`	Undocumented
severity:`str`	Undocumented
file:`Optional[str]`	Undocumented
only_once:`bool`	Undocumented
allow_dups:`bool`	Undocumented
origin_line:`Optional[int]`	Undocumented
offset:`int`	Undocumented
end_line:`Optional[int]`	Undocumented

def report_hidden_errors(self, info): (source)

Undocumented

Parameters
info:`ErrorInfo`	Undocumented

def reset(self): (source)

Undocumented

def set_file(self, file, module, scope=None): (source)

Set the path and module id of the current file.

Parameters
file:`str`	Undocumented
module:`Optional[str]`	Undocumented
scope:`Optional[Scope]`	Undocumented

def set_file_ignored_lines(self, file, ignored_lines, ignore_all=False): (source)

Undocumented

Parameters
file:`str`	Undocumented
ignored_lines:`Dict[int, List[str]]`	Undocumented
ignore_all:`bool`	Undocumented

def set_ignore_prefix(self, prefix): (source)

Set path prefix that will be removed from all paths.

Parameters
prefix:`str`	Undocumented

def set_import_context(self, ctx): (source)

Replace the entire import context with a new value.

Parameters
ctx:`List[Tuple[str, int]]`	Undocumented

def simplify_path(self, file): (source)

Undocumented

Parameters
file:`str`	Undocumented
Returns
`str`	Undocumented

def sort_messages(self, errors): (source)

Sort an array of error messages locally by line number.

I.e., sort a run of consecutive messages with the same context by line number, but otherwise retain the general ordering of the messages.

Parameters
errors:`List[ErrorInfo]`	Undocumented
Returns
`List[ErrorInfo]`	Undocumented

def targets(self): (source)

Return a set of all targets that contain errors.

Returns
`Set[str]`	Undocumented

def total_errors(self): (source)

Undocumented

Returns
`int`	Undocumented

disabled_error_codes = (source)

Undocumented

enabled_error_codes = (source)

Undocumented

error_info_map = (source)

Undocumented

file = (source)

Undocumented

flushed_files = (source)

Undocumented

function_or_member: list = (source)

Undocumented

ignore_prefix = (source)

Undocumented

ignored_files = (source)

Undocumented

ignored_lines = (source)

Undocumented

import_ctx = (source)

Undocumented

many_errors_threshold = (source)

Undocumented

only_once_messages = (source)

Undocumented

pretty = (source)

Undocumented

read_source = (source)

Undocumented

scope = (source)

Undocumented

seen_import_error: bool = (source)

Undocumented

show_absolute_path = (source)

Undocumented

show_column_numbers = (source)

Undocumented

show_error_codes = (source)

Undocumented

show_error_context = (source)

Undocumented

target_module = (source)

Undocumented

used_ignored_lines = (source)

Undocumented

def _add_error_info(self, file, info): (source)

Undocumented

Parameters
file:`str`	Undocumented
info:`ErrorInfo`	Undocumented