mypy.stubtest

module documentation

(source)

Tests for stubs.

Verify that various things in stubs are consistent with how things behave at runtime.

Class	`Error`	No class docstring; 0/6 instance variable, 4/4 methods documented
Class	`Missing`	Marker object for things that are missing (from a stub or the runtime).
Class	`Signature`	No class docstring; 0/4 instance variable, 0/2 method, 1/3 static method documented
Function	`build_stubs`	Uses mypy to construct stub objects for the given modules.
Function	`get_allowlist_entries`	Undocumented
Function	`get_mypy_type_of_runtime_value`	Returns a mypy type object representing the type of `runtime`.
Function	`get_stub`	Returns a stub object for the given module, if we've built one.
Function	`get_typeshed_stdlib_modules`	Returns a list of stdlib modules in typeshed (for current Python version).
Function	`is_dunder`	Returns whether name is a dunder name.
Function	`is_probably_a_function`	Undocumented
Function	`is_subtype_helper`	Checks whether `left` is a subtype of `right`.
Function	`main`	Undocumented
Function	`maybe_strip_cls`	Undocumented
Function	`parse_options`	Undocumented
Function	`safe_inspect_signature`	Undocumented
Function	`test_module`	Tests a given module's stub against introspecting it at runtime.
Function	`test_stubs`	This is stubtest! It's time to test the stubs!
Function	`verify`	Entry point for comparing a stub to a runtime object.
Function	`verify_decorator`	Undocumented
Function	`verify_funcitem`	Undocumented
Function	`verify_mypyfile`	Undocumented
Function	`verify_none`	Undocumented
Function	`verify_overloadedfuncdef`	Undocumented
Function	`verify_typealias`	Undocumented
Function	`verify_typeinfo`	Undocumented
Function	`verify_typevarexpr`	Undocumented
Function	`verify_var`	Undocumented
Constant	`MISSING`	Undocumented
Constant	`SPECIAL_DUNDERS`	Undocumented
Constant	`T`	Undocumented
Variable	`MaybeMissing`	Undocumented
Function	`_resolve_funcitem_from_decorator`	Returns a FuncItem that corresponds to the output of the decorator.
Function	`_style`	Wrapper around mypy.util for fancy formatting.
Function	`_verify_arg_default_value`	Checks whether argument default values are compatible.
Function	`_verify_arg_name`	Checks whether argument names match.
Function	`_verify_property`	Undocumented
Function	`_verify_signature`	Undocumented
Function	`_verify_static_class_methods`	Undocumented
Variable	`_all_stubs`	Undocumented
Variable	`_formatter`	Undocumented

def build_stubs(modules, options, find_submodules=False): (source)

Uses mypy to construct stub objects for the given modules.

This sets global state that get_stub can access.

Returns all modules we might want to check. If find_submodules is False, this is equal to modules.

Parameters
modules:`List[str]`	List of modules to build stubs for.
options:`Options`	Mypy options for finding and building stubs.
find_submodules:`bool`	Whether to attempt to find submodules of the given modules as well.
Returns
`List[str]`	Undocumented

def get_allowlist_entries(allowlist_file): (source)

Undocumented

Parameters
allowlist_file:`str`	Undocumented
Returns
`Iterator[str]`	Undocumented

def get_mypy_type_of_runtime_value(runtime): (source)

Returns a mypy type object representing the type of runtime.

Returns None if we can't find something that works.

Parameters
runtime:`Any`	Undocumented
Returns
`Optional[mypy.types.Type]`	Undocumented

def get_stub(module): (source)

Returns a stub object for the given module, if we've built one.

Parameters
module:`str`	Undocumented
Returns
`Optional[nodes.MypyFile]`	Undocumented

def get_typeshed_stdlib_modules(custom_typeshed_dir): (source)

Returns a list of stdlib modules in typeshed (for current Python version).

Parameters
custom_typeshed_dir:`Optional[str]`	Undocumented
Returns
`List[str]`	Undocumented

def is_dunder(name, exclude_special=False): (source)

Returns whether name is a dunder name.

Parameters
name:`str`	Undocumented
exclude_special:`bool`	Whether to return False for a couple special dunder methods.
Returns
`bool`	Undocumented

def is_probably_a_function(runtime): (source)

Undocumented

Parameters
runtime:`Any`	Undocumented
Returns
`bool`	Undocumented

def is_subtype_helper(left, right): (source)

Checks whether left is a subtype of right.

Parameters
left:`mypy.types.Type`	Undocumented
right:`mypy.types.Type`	Undocumented
Returns
`bool`	Undocumented

def main(): (source)

Undocumented

Returns
`int`	Undocumented

def maybe_strip_cls(name, args): (source)

Undocumented

Parameters
name:`str`	Undocumented
args:`List[nodes.Argument]`	Undocumented
Returns
`List[nodes.Argument]`	Undocumented

def parse_options(args): (source)

Undocumented

Parameters
args:`List[str]`	Undocumented
Returns
`argparse.Namespace`	Undocumented

def safe_inspect_signature(runtime): (source)

Undocumented

Parameters
runtime:`Any`	Undocumented
Returns
`Optional[inspect.Signature]`	Undocumented

def test_module(module_name): (source)

Tests a given module's stub against introspecting it at runtime.

Requires the stub to have been built already, accomplished by a call to build_stubs.

Parameters
module_name:`str`	The module to test
Returns
`Iterator[Error]`	Undocumented

def test_stubs(args, use_builtins_fixtures=False): (source)

This is stubtest! It's time to test the stubs!

Parameters
args:`argparse.Namespace`	Undocumented
use_builtins_fixtures:`bool`	Undocumented
Returns
`int`	Undocumented

@singledispatch
def verify(stub, runtime, object_path): (source)

Entry point for comparing a stub to a runtime object.

We use single dispatch based on the type of stub.

Parameters
stub:`MaybeMissing[nodes.Node]`	The mypy node representing a part of the stub
runtime:`MaybeMissing[Any]`	The runtime object corresponding to `stub`
object_path:`List[str]`	Undocumented
Returns
`Iterator[Error]`	Undocumented

@verify.register(nodes.Decorator)
def verify_decorator(stub, runtime, object_path): (source)

Undocumented

Parameters
stub:`nodes.Decorator`	Undocumented
runtime:`MaybeMissing[Any]`	Undocumented
object_path:`List[str]`	Undocumented
Returns
`Iterator[Error]`	Undocumented

@verify.register(nodes.FuncItem)
def verify_funcitem(stub, runtime, object_path): (source)

Undocumented

Parameters
stub:`nodes.FuncItem`	Undocumented
runtime:`MaybeMissing[Any]`	Undocumented
object_path:`List[str]`	Undocumented
Returns
`Iterator[Error]`	Undocumented

@verify.register(nodes.MypyFile)
def verify_mypyfile(stub, runtime, object_path): (source)

Undocumented

Parameters
stub:`nodes.MypyFile`	Undocumented
runtime:`MaybeMissing[types.ModuleType]`	Undocumented
object_path:`List[str]`	Undocumented
Returns
`Iterator[Error]`	Undocumented

@verify.register(Missing)
def verify_none(stub, runtime, object_path): (source)

Undocumented

Parameters
stub:`Missing`	Undocumented
runtime:`MaybeMissing[Any]`	Undocumented
object_path:`List[str]`	Undocumented
Returns
`Iterator[Error]`	Undocumented

@verify.register(nodes.OverloadedFuncDef)
def verify_overloadedfuncdef(stub, runtime, object_path): (source)

Undocumented

Parameters
stub:`nodes.OverloadedFuncDef`	Undocumented
runtime:`MaybeMissing[Any]`	Undocumented
object_path:`List[str]`	Undocumented
Returns
`Iterator[Error]`	Undocumented

@verify.register(nodes.TypeAlias)
def verify_typealias(stub, runtime, object_path): (source)

Undocumented

Parameters
stub:`nodes.TypeAlias`	Undocumented
runtime:`MaybeMissing[Any]`	Undocumented
object_path:`List[str]`	Undocumented
Returns
`Iterator[Error]`	Undocumented

@verify.register(nodes.TypeInfo)
def verify_typeinfo(stub, runtime, object_path): (source)

Undocumented

Parameters
stub:`nodes.TypeInfo`	Undocumented
runtime:`MaybeMissing[Type[Any]]`	Undocumented
object_path:`List[str]`	Undocumented
Returns
`Iterator[Error]`	Undocumented

@verify.register(nodes.TypeVarExpr)
def verify_typevarexpr(stub, runtime, object_path): (source)

Undocumented

Parameters
stub:`nodes.TypeVarExpr`	Undocumented
runtime:`MaybeMissing[Any]`	Undocumented
object_path:`List[str]`	Undocumented
Returns
`Iterator[Error]`	Undocumented

@verify.register(nodes.Var)
def verify_var(stub, runtime, object_path): (source)

Undocumented

Parameters
stub:`nodes.Var`	Undocumented
runtime:`MaybeMissing[Any]`	Undocumented
object_path:`List[str]`	Undocumented
Returns
`Iterator[Error]`	Undocumented

MISSING = (source)

Undocumented

Value

Missing()

SPECIAL_DUNDERS: tuple[str, ...] = (source)

Undocumented

Value

('__init__', '__new__', '__call__', '__init_subclass__', '__class_getitem__')

T = (source)

Undocumented

Value

TypeVar('T')

MaybeMissing = (source)

Undocumented

def _resolve_funcitem_from_decorator(dec): (source)

Returns a FuncItem that corresponds to the output of the decorator.

Returns None if we can't figure out what that would be. For convenience, this function also accepts FuncItems.

Parameters
dec:`nodes.OverloadPart`	Undocumented
Returns
`Optional[nodes.FuncItem]`	Undocumented

def _style(message, **kwargs): (source)

Wrapper around mypy.util for fancy formatting.

Parameters
message:`str`	Undocumented
**kwargs:`Any`	Undocumented
Returns
`str`	Undocumented

def _verify_arg_default_value(stub_arg, runtime_arg): (source)

Checks whether argument default values are compatible.

Parameters
stub_arg:`nodes.Argument`	Undocumented
runtime_arg:`inspect.Parameter`	Undocumented
Returns
`Iterator[str]`	Undocumented

def _verify_arg_name(stub_arg, runtime_arg, function_name): (source)

Checks whether argument names match.

Parameters
stub_arg:`nodes.Argument`	Undocumented
runtime_arg:`inspect.Parameter`	Undocumented
function_name:`str`	Undocumented
Returns
`Iterator[str]`	Undocumented

def _verify_property(stub, runtime): (source)

Undocumented

Parameters
stub:`nodes.Decorator`	Undocumented
runtime:`Any`	Undocumented
Returns
`Iterator[str]`	Undocumented

def _verify_signature(stub, runtime, function_name): (source)

Undocumented

Parameters
stub:`Signature[nodes.Argument]`	Undocumented
runtime:`Signature[inspect.Parameter]`	Undocumented
function_name:`str`	Undocumented
Returns
`Iterator[str]`	Undocumented

def _verify_static_class_methods(stub, runtime, object_path): (source)

Undocumented

Parameters
stub:`nodes.FuncBase`	Undocumented
runtime:`Any`	Undocumented
object_path:`List[str]`	Undocumented
Returns
`Iterator[str]`	Undocumented

_all_stubs: Dict[str, nodes.MypyFile] = (source)

Undocumented

_formatter = (source)

Undocumented