mypy.typeanal.TypeAnalyser

class documentation

class TypeAnalyser(SyntheticTypeVisitor[Type], TypeAnalyzerPluginInterface): (source)

Semantic analyzer for types.

Converts unbound types into bound types. This is a no-op for already bound types.

If an incomplete reference is encountered, this does a defer. The caller never needs to defer.

Method	`__init__`	Undocumented
Method	`anal_array`	Undocumented
Method	`anal_star_arg_type`	Analyze signature argument type for args and *kwargs argument.
Method	`anal_type`	Undocumented
Method	`anal_type_guard`	Undocumented
Method	`anal_type_guard_arg`	Undocumented
Method	`anal_var_def`	Undocumented
Method	`anal_var_defs`	Undocumented
Method	`analyze_callable_args`	Find types, kinds, and names of arguments from extended callable syntax.
Method	`analyze_callable_args_for_paramspec`	Construct a 'Callable[P, RET]', where P is ParamSpec, return None if we cannot.
Method	`analyze_callable_type`	Undocumented
Method	`analyze_literal_param`	Undocumented
Method	`analyze_literal_type`	Undocumented
Method	`analyze_type`	Analyze an unbound type using the default mypy logic.
Method	`analyze_type_with_type_info`	Bind unbound type when were able to find target TypeInfo.
Method	`analyze_unbound_type_without_type_info`	Figure out what an unbound type that doesn't refer to a TypeInfo node means.
Method	`bind_function_type_variables`	Find the type variables of the function type and bind them in our tvar_scope
Method	`cannot_resolve_type`	Undocumented
Method	`fail`	Emit an error message at given location.
Method	`get_omitted_any`	Undocumented
Method	`infer_type_variables`	Return list of unique type variables referred to in a callable.
Method	`is_defined_type_var`	Undocumented
Method	`named_type`	Construct an instance of a builtin type with given name.
Method	`named_type_with_normalized_str`	Does almost the same thing as `named_type`, except that we immediately unalias `builtins.bytes` and `builtins.unicode` to `builtins.str` as appropriate.
Method	`note`	Undocumented
Method	`try_analyze_special_unbound_type`	Bind special type that is recognized through magic name such as 'typing.Any'.
Method	`tuple_type`	Undocumented
Method	`tvar_scope_frame`	Undocumented
Method	`visit_any`	Undocumented
Method	`visit_callable_argument`	Undocumented
Method	`visit_callable_type`	Undocumented
Method	`visit_deleted_type`	Undocumented
Method	`visit_ellipsis_type`	Undocumented
Method	`visit_erased_type`	Undocumented
Method	`visit_instance`	Undocumented
Method	`visit_literal_type`	Undocumented
Method	`visit_none_type`	Undocumented
Method	`visit_overloaded`	Undocumented
Method	`visit_param_spec`	Undocumented
Method	`visit_partial_type`	Undocumented
Method	`visit_placeholder_type`	Undocumented
Method	`visit_raw_expression_type`	Undocumented
Method	`visit_star_type`	Undocumented
Method	`visit_tuple_type`	Undocumented
Method	`visit_type_alias_type`	Undocumented
Method	`visit_type_list`	Undocumented
Method	`visit_type_type`	Undocumented
Method	`visit_type_var`	Undocumented
Method	`visit_typeddict_type`	Undocumented
Method	`visit_unbound_type`	Undocumented
Method	`visit_unbound_type_nonoptional`	Undocumented
Method	`visit_uninhabited_type`	Undocumented
Method	`visit_union_type`	Undocumented
Class Variable	`global_scope`	Undocumented
Class Variable	`in_dynamic_func`	Undocumented
Instance Variable	`aliases_used`	Undocumented
Instance Variable	`allow_new_syntax`	Undocumented
Instance Variable	`allow_placeholder`	Undocumented
Instance Variable	`allow_required`	Undocumented
Instance Variable	`allow_tuple_literal`	Undocumented
Instance Variable	`allow_unbound_tvars`	Undocumented
Instance Variable	`api`	Undocumented
Instance Variable	`defining_alias`	Undocumented
Instance Variable	`fail_func`	Undocumented
Instance Variable	`is_typeshed_stub`	Undocumented
Instance Variable	`lookup_fqn_func`	Undocumented
Instance Variable	`lookup_qualified`	Undocumented
Instance Variable	`nesting_level`	Undocumented
Instance Variable	`note_func`	Undocumented
Instance Variable	`options`	Undocumented
Instance Variable	`plugin`	Undocumented
Instance Variable	`report_invalid_types`	Undocumented
Instance Variable	`tvar_scope`	Undocumented

def __init__(self, api, tvar_scope, plugin, options, is_typeshed_stub, *, defining_alias=False, allow_tuple_literal=False, allow_new_syntax=False, allow_unbound_tvars=False, allow_placeholder=False, allow_required=False, report_invalid_types=True): (source)

Undocumented

Parameters
api:`SemanticAnalyzerCoreInterface`	Undocumented
tvar_scope:`TypeVarLikeScope`	Undocumented
plugin:`Plugin`	Undocumented
options:`Options`	Undocumented
is_typeshed_stub:`bool`	Undocumented
defining_alias:`bool`	Undocumented
allow_tuple_literal:`bool`	Undocumented
allow_new_syntax:`bool`	Undocumented
allow_unbound_tvars:`bool`	Undocumented
allow_placeholder:`bool`	Undocumented
allow_required:`bool`	Undocumented
report_invalid_types:`bool`	Undocumented

def anal_array(self, a, nested=True, *, allow_param_spec=False): (source)

Undocumented

Parameters
a:`Iterable[Type]`	Undocumented
nested:`bool`	Undocumented
allow_param_spec:`bool`	Undocumented
Returns
`List[Type]`	Undocumented

def anal_star_arg_type(self, t, kind, nested): (source)

Analyze signature argument type for *args and **kwargs argument.

Parameters
t:`Type`	Undocumented
kind:`ArgKind`	Undocumented
nested:`bool`	Undocumented
Returns
`Type`	Undocumented

def anal_type(self, t, nested=True, *, allow_param_spec=False): (source)

Undocumented

Parameters
t:`Type`	Undocumented
nested:`bool`	Undocumented
allow_param_spec:`bool`	Undocumented
Returns
`Type`	Undocumented

def anal_type_guard(self, t): (source)

Undocumented

Parameters
t:`Type`	Undocumented
Returns
`Optional[Type]`	Undocumented

def anal_type_guard_arg(self, t, fullname): (source)

Undocumented

Parameters
t:`UnboundType`	Undocumented
fullname:`str`	Undocumented
Returns
`Optional[Type]`	Undocumented

def anal_var_def(self, var_def): (source)

Undocumented

Parameters
var_def:`TypeVarLikeType`	Undocumented
Returns
`TypeVarLikeType`	Undocumented

def anal_var_defs(self, var_defs): (source)

Undocumented

Parameters
var_defs:`Sequence[TypeVarLikeType]`	Undocumented
Returns
`List[TypeVarLikeType]`	Undocumented

def analyze_callable_args(self, arglist): (source)

overrides mypy.plugin.TypeAnalyzerPluginInterface.analyze_callable_args

Find types, kinds, and names of arguments from extended callable syntax.

Parameters
arglist:`TypeList`	Undocumented
Returns
`Optional[Tuple[List[Type], List[ArgKind], List[Optional[str]]]]`	Undocumented

def analyze_callable_args_for_paramspec(self, callable_args, ret_type, fallback): (source)

Construct a 'Callable[P, RET]', where P is ParamSpec, return None if we cannot.

Parameters
callable_args:`Type`	Undocumented
ret_type:`Type`	Undocumented
fallback:`Instance`	Undocumented
Returns
`Optional[CallableType]`	Undocumented

def analyze_callable_type(self, t): (source)

Undocumented

Parameters
t:`UnboundType`	Undocumented
Returns
`Type`	Undocumented

def analyze_literal_param(self, idx, arg, ctx): (source)

Undocumented

Parameters
idx:`int`	Undocumented
arg:`Type`	Undocumented
ctx:`Context`	Undocumented
Returns
`Optional[List[Type]]`	Undocumented

def analyze_literal_type(self, t): (source)

Undocumented

Parameters
t:`UnboundType`	Undocumented
Returns
`Type`	Undocumented

def analyze_type(self, t): (source)

overrides mypy.plugin.TypeAnalyzerPluginInterface.analyze_type

Analyze an unbound type using the default mypy logic.

Parameters
t:`Type`	Undocumented
Returns
`Type`	Undocumented

def analyze_type_with_type_info(self, info, args, ctx): (source)

Bind unbound type when were able to find target TypeInfo.

This handles simple cases like 'int', 'modname.UserClass[str]', etc.

Parameters
info:`TypeInfo`	Undocumented
args:`Sequence[Type]`	Undocumented
ctx:`Context`	Undocumented
Returns
`Type`	Undocumented

def analyze_unbound_type_without_type_info(self, t, sym, defining_literal): (source)

Figure out what an unbound type that doesn't refer to a TypeInfo node means.

This is something unusual. We try our best to find out what it is.

Parameters
t:`UnboundType`	Undocumented
sym:`SymbolTableNode`	Undocumented
defining_literal:`bool`	Undocumented
Returns
`Type`	Undocumented

def bind_function_type_variables(self, fun_type, defn): (source)

Find the type variables of the function type and bind them in our tvar_scope

Parameters
fun_type:`CallableType`	Undocumented
defn:`Context`	Undocumented
Returns
`Sequence[TypeVarLikeType]`	Undocumented

def cannot_resolve_type(self, t): (source)

Undocumented

Parameters
t:`UnboundType`	Undocumented

def fail(self, msg, ctx, *, code=None): (source)

overrides mypy.plugin.TypeAnalyzerPluginInterface.fail

Emit an error message at given location.

Parameters
msg:`str`	Undocumented
ctx:`Context`	Undocumented
code:`Optional[ErrorCode]`	Undocumented

def get_omitted_any(self, typ, fullname=None): (source)

Undocumented

Parameters
typ:`Type`	Undocumented
fullname:`Optional[str]`	Undocumented
Returns
`AnyType`	Undocumented

def infer_type_variables(self, type): (source)

Return list of unique type variables referred to in a callable.

Parameters
type:`CallableType`	Undocumented
Returns
`List[Tuple[str, TypeVarLikeExpr]]`	Undocumented

def is_defined_type_var(self, tvar, context): (source)

Undocumented

Parameters
tvar:`str`	Undocumented
context:`Context`	Undocumented
Returns
`bool`	Undocumented

def named_type(self, fully_qualified_name, args=None, line=-1, column=-1): (source)

overrides mypy.plugin.TypeAnalyzerPluginInterface.named_type

Construct an instance of a builtin type with given name.

Parameters
fully_qualified_name:`str`	Undocumented
args:`Optional[List[Type]]`	Undocumented
line:`int`	Undocumented
column:`int`	Undocumented
Returns
`Instance`	Undocumented

def named_type_with_normalized_str(self, fully_qualified_name): (source)

Does almost the same thing as named_type, except that we immediately unalias builtins.bytes and builtins.unicode to builtins.str as appropriate.

Parameters
fully_qualified_name:`str`	Undocumented
Returns
`Instance`	Undocumented

def note(self, msg, ctx, *, code=None): (source)

Undocumented

Parameters
msg:`str`	Undocumented
ctx:`Context`	Undocumented
code:`Optional[ErrorCode]`	Undocumented

def try_analyze_special_unbound_type(self, t, fullname): (source)

Bind special type that is recognized through magic name such as 'typing.Any'.

Return the bound type if successful, and return None if the type is a normal type.

Parameters
t:`UnboundType`	Undocumented
fullname:`str`	Undocumented
Returns
`Optional[Type]`	Undocumented

def tuple_type(self, items): (source)

Undocumented

Parameters
items:`List[Type]`	Undocumented
Returns
`TupleType`	Undocumented

@contextmanager
def tvar_scope_frame(self): (source)

Undocumented

Returns
`Iterator[None]`	Undocumented

def visit_any(self, t): (source)

Undocumented

Parameters
t:`AnyType`	Undocumented
Returns
`Type`	Undocumented

def visit_callable_argument(self, t): (source)

Undocumented

Parameters
t:`CallableArgument`	Undocumented
Returns
`Type`	Undocumented

def visit_callable_type(self, t, nested=True): (source)

Undocumented

Parameters
t:`CallableType`	Undocumented
nested:`bool`	Undocumented
Returns
`Type`	Undocumented

def visit_deleted_type(self, t): (source)

Undocumented

Parameters
t:`DeletedType`	Undocumented
Returns
`Type`	Undocumented

def visit_ellipsis_type(self, t): (source)

Undocumented

Parameters
t:`EllipsisType`	Undocumented
Returns
`Type`	Undocumented

def visit_erased_type(self, t): (source)

Undocumented

Parameters
t:`ErasedType`	Undocumented
Returns
`Type`	Undocumented

def visit_instance(self, t): (source)

Undocumented

Parameters
t:`Instance`	Undocumented
Returns
`Type`	Undocumented

def visit_literal_type(self, t): (source)

Undocumented

Parameters
t:`LiteralType`	Undocumented
Returns
`Type`	Undocumented

def visit_none_type(self, t): (source)

Undocumented

Parameters
t:`NoneType`	Undocumented
Returns
`Type`	Undocumented

def visit_overloaded(self, t): (source)

Undocumented

Parameters
t:`Overloaded`	Undocumented
Returns
`Type`	Undocumented

def visit_param_spec(self, t): (source)

Undocumented

Parameters
t:`ParamSpecType`	Undocumented
Returns
`Type`	Undocumented

def visit_partial_type(self, t): (source)

Undocumented

Parameters
t:`PartialType`	Undocumented
Returns
`Type`	Undocumented

def visit_placeholder_type(self, t): (source)

Undocumented

Parameters
t:`PlaceholderType`	Undocumented
Returns
`Type`	Undocumented

def visit_raw_expression_type(self, t): (source)

Undocumented

Parameters
t:`RawExpressionType`	Undocumented
Returns
`Type`	Undocumented

def visit_star_type(self, t): (source)

Undocumented

Parameters
t:`StarType`	Undocumented
Returns
`Type`	Undocumented

def visit_tuple_type(self, t): (source)

Undocumented

Parameters
t:`TupleType`	Undocumented
Returns
`Type`	Undocumented

def visit_type_alias_type(self, t): (source)

Undocumented

Parameters
t:`TypeAliasType`	Undocumented
Returns
`Type`	Undocumented

def visit_type_list(self, t): (source)

Undocumented

Parameters
t:`TypeList`	Undocumented
Returns
`Type`	Undocumented

def visit_type_type(self, t): (source)

Undocumented

Parameters
t:`TypeType`	Undocumented
Returns
`Type`	Undocumented

def visit_type_var(self, t): (source)

Undocumented

Parameters
t:`TypeVarType`	Undocumented
Returns
`Type`	Undocumented

def visit_typeddict_type(self, t): (source)

Undocumented

Parameters
t:`TypedDictType`	Undocumented
Returns
`Type`	Undocumented

def visit_unbound_type(self, t, defining_literal=False): (source)

Undocumented

Parameters
t:`UnboundType`	Undocumented
defining_literal:`bool`	Undocumented
Returns
`Type`	Undocumented

def visit_unbound_type_nonoptional(self, t, defining_literal): (source)

Undocumented

Parameters
t:`UnboundType`	Undocumented
defining_literal:`bool`	Undocumented
Returns
`Type`	Undocumented

def visit_uninhabited_type(self, t): (source)

Undocumented

Parameters
t:`UninhabitedType`	Undocumented
Returns
`Type`	Undocumented

def visit_union_type(self, t): (source)

Undocumented

Parameters
t:`UnionType`	Undocumented
Returns
`Type`	Undocumented

global_scope: bool = (source)

Undocumented

in_dynamic_func: bool = (source)

Undocumented

aliases_used: Set[str] = (source)

Undocumented

allow_new_syntax = (source)

Undocumented

allow_placeholder = (source)

Undocumented

allow_required = (source)

Undocumented

allow_tuple_literal = (source)

Undocumented

allow_unbound_tvars = (source)

Undocumented

api = (source)

Undocumented

defining_alias = (source)

Undocumented

fail_func = (source)

Undocumented

is_typeshed_stub = (source)

Undocumented

lookup_fqn_func = (source)

Undocumented

lookup_qualified = (source)

Undocumented

nesting_level: int = (source)

Undocumented

note_func = (source)

Undocumented

options = (source)

overrides mypy.plugin.TypeAnalyzerPluginInterface.options

Undocumented

plugin = (source)

Undocumented

report_invalid_types = (source)

Undocumented

tvar_scope = (source)

Undocumented