mypy.stubtest.Error

class documentation

class Error: (source)

Undocumented

Method	`__init__`	Represents an error found by stubtest.
Method	`get_description`	Returns a description of the error.
Method	`is_missing_stub`	Whether or not the error is for something missing from the stub.
Method	`is_positional_only_related`	Whether or not the error is for something being (or not being) positional-only.
Instance Variable	`message`	Undocumented
Instance Variable	`object_desc`	Undocumented
Instance Variable	`object_path`	Undocumented
Instance Variable	`runtime_desc`	Undocumented
Instance Variable	`runtime_object`	Undocumented
Instance Variable	`stub_desc`	Undocumented
Instance Variable	`stub_object`	Undocumented

def __init__(self, object_path: list[str], message: str, stub_object: MaybeMissing[nodes.Node], runtime_object: MaybeMissing[Any], *, stub_desc: str|None = None, runtime_desc: str|None = None): (source) ¶

Represents an error found by stubtest. :param object_path: Location of the object with the error, e.g. ``["module", "Class", "method"]`` :param message: Error message :param stub_object: The mypy node representing the stub :param runtime_object: Actual object obtained from the runtime :param stub_desc: Specialised description for the stub object, should you wish :param runtime_desc: Specialised description for the runtime object, should you wish

def get_description(self, concise: bool = False) -> str: (source) ¶

Returns a description of the error. :param concise: Whether to return a concise, one-line description

def is_missing_stub(self) -> bool: (source) ¶

Whether or not the error is for something missing from the stub.

def is_positional_only_related(self) -> bool: (source) ¶

Whether or not the error is for something being (or not being) positional-only.

message = (source) ¶

Undocumented

object_desc = (source) ¶

Undocumented

object_path = (source) ¶

Undocumented