mypy.typeanal

module documentation

(source)

Semantic analysis of types

Class	`CollectAllInnerTypesQuery`	Undocumented
Class	`CollectAnyTypesQuery`	Undocumented
Class	`HasAnyFromUnimportedType`	Undocumented
Class	`HasExplicitAny`	Undocumented
Class	`InstanceFixer`	Undocumented
Class	`TypeAnalyser`	Semantic analyzer for types.
Class	`TypeVarLikeQuery`	Find TypeVar and ParamSpec references in an unbound type.
Function	`analyze_type_alias`	Analyze r.h.s. of a (potential) type alias definition.
Function	`check_for_explicit_any`	Undocumented
Function	`collect_all_inner_types`	Return all types that `t` contains
Function	`collect_any_types`	Return all inner `AnyType`s of type t
Function	`expand_type_alias`	Expand a (generic) type alias target following the rules outlined in TypeAlias docstring.
Function	`fix_instance`	Fix a malformed instance by replacing all type arguments with Any.
Function	`fix_instance_types`	Recursively fix all instance types (type argument count) in a given type.
Function	`flatten_tvars`	Undocumented
Function	`get_omitted_any`	Undocumented
Function	`has_any_from_unimported_type`	Return true if this type is Any because an import was not followed.
Function	`has_explicit_any`	Whether this type is or type it contains is an Any coming from explicit type annotation
Function	`make_optional_type`	Return the type corresponding to Optional[t].
Function	`no_subscript_builtin_alias`	Undocumented
Function	`remove_dups`	Undocumented
Function	`set_any_tvars`	Undocumented
Constant	`ARG_KINDS_BY_CONSTRUCTOR`	Undocumented
Constant	`GENERIC_STUB_NOT_AT_RUNTIME_TYPES`	Undocumented
Constant	`T`	Undocumented
Constant	`type_constructors`	Undocumented
Variable	`MsgCallback`	Undocumented
Variable	`TypeVarLikeList`	Undocumented

def analyze_type_alias(node, api, tvar_scope, plugin, options, is_typeshed_stub, allow_new_syntax=False, allow_placeholder=False, in_dynamic_func=False, global_scope=True): (source)

Analyze r.h.s. of a (potential) type alias definition.

If node is valid as a type alias rvalue, return the resulting type and a set of full names of type aliases it depends on (directly or indirectly). Return None otherwise. 'node' must have been semantically analyzed.

Parameters
node:`Expression`	Undocumented
api:`SemanticAnalyzerCoreInterface`	Undocumented
tvar_scope:`TypeVarLikeScope`	Undocumented
plugin:`Plugin`	Undocumented
options:`Options`	Undocumented
is_typeshed_stub:`bool`	Undocumented
allow_new_syntax:`bool`	Undocumented
allow_placeholder:`bool`	Undocumented
in_dynamic_func:`bool`	Undocumented
global_scope:`bool`	Undocumented
Returns
`Optional[Tuple[Type, Set[str]]]`	Undocumented

def check_for_explicit_any(typ, options, is_typeshed_stub, msg, context): (source)

Undocumented

Parameters
typ:`Optional[Type]`	Undocumented
options:`Options`	Undocumented
is_typeshed_stub:`bool`	Undocumented
msg:`MessageBuilder`	Undocumented
context:`Context`	Undocumented

def collect_all_inner_types(t): (source)

Return all types that t contains

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

def collect_any_types(t): (source)

Return all inner `AnyType`s of type t

Parameters
t:`Type`	Undocumented
Returns
`List[AnyType]`	Undocumented

def expand_type_alias(node, args, fail, no_args, ctx, *, unexpanded_type=None, disallow_any=False): (source)

Expand a (generic) type alias target following the rules outlined in TypeAlias docstring.

Here:: target: original target type (contains unbound type variables) alias_tvars: type variable names args: types to be substituted in place of type variables fail: error reporter callback no_args: whether original definition used a bare generic A = List ctx: context where expansion happens

Parameters
node:`TypeAlias`	Undocumented
args:`List[Type]`	Undocumented
fail:`MsgCallback`	Undocumented
no_args:`bool`	Undocumented
ctx:`Context`	Undocumented
unexpanded_type:`Optional[Type]`	Undocumented
disallow_any:`bool`	Undocumented
Returns
`Type`	Undocumented

def fix_instance(t, fail, note, disallow_any, python_version, use_generic_error=False, unexpanded_type=None): (source)

Fix a malformed instance by replacing all type arguments with Any.

Also emit a suitable error if this is not due to implicit Any's.

Parameters
t:`Instance`	Undocumented
fail:`MsgCallback`	Undocumented
note:`MsgCallback`	Undocumented
disallow_any:`bool`	Undocumented
python_version:`Tuple[int, int]`	Undocumented
use_generic_error:`bool`	Undocumented
unexpanded_type:`Optional[Type]`	Undocumented

def fix_instance_types(t, fail, note, python_version): (source)

Recursively fix all instance types (type argument count) in a given type.

For example 'Union[Dict, List[str, int]]' will be transformed into 'Union[Dict[Any, Any], List[Any]]' in place.

Parameters
t:`Type`	Undocumented
fail:`MsgCallback`	Undocumented
note:`MsgCallback`	Undocumented
python_version:`Tuple[int, int]`	Undocumented

def flatten_tvars(ll): (source)

Undocumented

Parameters
ll:`Iterable[List[T]]`	Undocumented
Returns
`List[T]`	Undocumented

def get_omitted_any(disallow_any, fail, note, orig_type, python_version, fullname=None, unexpanded_type=None): (source)

Undocumented

Parameters
disallow_any:`bool`	Undocumented
fail:`MsgCallback`	Undocumented
note:`MsgCallback`	Undocumented
orig_type:`Type`	Undocumented
python_version:`Tuple[int, int]`	Undocumented
fullname:`Optional[str]`	Undocumented
unexpanded_type:`Optional[Type]`	Undocumented
Returns
`AnyType`	Undocumented

def has_any_from_unimported_type(t): (source)

Return true if this type is Any because an import was not followed.

If type t is such Any type or has type arguments that contain such Any type this function will return true.

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

def has_explicit_any(t): (source)

Whether this type is or type it contains is an Any coming from explicit type annotation

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

def make_optional_type(t): (source)

Return the type corresponding to Optional[t].

Note that we can't use normal union simplification, since this function is called during semantic analysis and simplification only works during type checking.

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

def no_subscript_builtin_alias(name, propose_alt=True): (source)

Undocumented

Parameters
name:`str`	Undocumented
propose_alt:`bool`	Undocumented
Returns
`str`	Undocumented

def remove_dups(tvars): (source)

Undocumented

Parameters
tvars:`Iterable[T]`	Undocumented
Returns
`List[T]`	Undocumented

def set_any_tvars(node, newline, newcolumn, *, from_error=False, disallow_any=False, fail=None, unexpanded_type=None): (source)

Undocumented

Parameters
node:`TypeAlias`	Undocumented
newline:`int`	Undocumented
newcolumn:`int`	Undocumented
from_error:`bool`	Undocumented
disallow_any:`bool`	Undocumented
fail:`Optional[MsgCallback]`	Undocumented
unexpanded_type:`Optional[Type]`	Undocumented
Returns
`Type`	Undocumented

ARG_KINDS_BY_CONSTRUCTOR = (source)

Undocumented

Value

{'mypy_extensions.Arg': ARG_POS,
 'mypy_extensions.DefaultArg': ARG_OPT,
 'mypy_extensions.NamedArg': ARG_NAMED,
 'mypy_extensions.DefaultNamedArg': ARG_NAMED_OPT,
 'mypy_extensions.VarArg': ARG_STAR,
 'mypy_extensions.KwArg': ARG_STAR2}

GENERIC_STUB_NOT_AT_RUNTIME_TYPES: set[str] = (source)

Undocumented

Value

set(['queue.Queue', 'builtins._PathLike', 'asyncio.futures.Future'])

T = (source)

Undocumented

Value

TypeVar('T')

type_constructors: set[str] = (source)

Undocumented

Value

set(['typing.Callable',
     'typing.Optional',
     'typing.Tuple',
     'typing.Type',
     'typing.Union',
     'typing.Literal',
     'typing_extensions.Literal',
...

MsgCallback = (source)

Undocumented

TypeVarLikeList = (source)

Undocumented