class documentation

class Error: (source)

View In Hierarchy

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 runtime​_desc Undocumented
Instance Variable runtime​_object Undocumented
Instance Variable stub​_desc Undocumented
Instance Variable stub​_object Undocumented
def __init__(self, object_path, message, stub_object, runtime_object, *, stub_desc=None, runtime_desc=None): (source)
Represents an error found by stubtest.
Parameters
object​_path:List[str]Location of the object with the error, e.g. ["module", "Class", "method"]
message:strError message
stub​_object:MaybeMissing[nodes.Node]The mypy node representing the stub
runtime​_object:MaybeMissing[Any]Actual object obtained from the runtime
stub​_desc:Optional[str]Specialised description for the stub object, should you wish
runtime​_desc:Optional[str]Specialised description for the runtime object, should you wish
def get_description(self, concise=False): (source)
Returns a description of the error.
Parameters
concise:boolWhether to return a concise, one-line description
Returns
strUndocumented
def is_missing_stub(self): (source)
Whether or not the error is for something missing from the stub.
Returns
boolUndocumented
def is_positional_only_related(self): (source)
Whether or not the error is for something being (or not being) positional-only.
Returns
boolUndocumented
message = (source)

Undocumented

object_desc = (source)

Undocumented

runtime_desc = (source)

Undocumented

runtime_object = (source)

Undocumented

stub_desc = (source)

Undocumented

stub_object = (source)

Undocumented