mypy.nodes

module documentation
(source)

Abstract syntax tree node classes (i.e. parse tree).
Class ​Arg​Kind Undocumented
Class ​Argument A single argument in a FuncItem.
Class ​Assert​Stmt Undocumented
Class ​Assignment​Expr Assignment expressions in Python 3.8+, like "a := 2".
Class ​Assignment​Stmt Assignment statement.
Class ​Await​Expr Await expression (await ...).
Class ​Backquote​Expr Python 2 expression ....
Class ​Block Undocumented
Class ​Break​Stmt Undocumented
Class ​Bytes​Expr Bytes literal
Class ​Call​Expr Call expression.
Class ​Cast​Expr Cast expression cast(type, expr).
Class ​Class​Def Class definition
Class ​Comparison​Expr Comparison expression (e.g. a < b > c < d).
Class ​Complex​Expr Complex literal
Class ​Conditional​Expr Conditional expression (e.g. x if y else z)
Class ​Context Base type for objects that are valid as error message locations.
Class ​Continue​Stmt Undocumented
Class ​Decorator A decorated function.
Class ​Del​Stmt Undocumented
Class ​Dict​Expr Dictionary literal expression {key: value, ...}.
Class ​Dictionary​Comprehension Dictionary comprehension (e.g. {k: v for k, v in a}
Class ​Ellipsis​Expr Ellipsis (...)
Class ​Enum​Call​Expr Named tuple expression Enum('name', 'val1 val2 ...').
Class ​Exec​Stmt Python 2 exec statement
Class ​Expression An expression node.
Class ​Expression​Stmt An expression as a statement, such as print(s).
Class ​Fake​Expression A dummy expression.
Class ​Fake​Info Undocumented
Class ​Float​Expr Float literal
Class ​For​Stmt Undocumented
Class ​Func​Base Abstract base class for function-like nodes.
Class ​Func​Def Function definition.
Class ​Func​Item Base class for nodes usable as overloaded function items.
Class ​Generator​Expr Generator expression ... for ... in ... [ for ... in ... ] [ if ... ].
Class ​Global​Decl Declaration global x, y, ...
Class ​If​Stmt Undocumented
Class ​Import import m [as n]
Class ​Import​All from m import *
Class ​Import​Base Base class for all import statements.
Class ​Imported​Name Indirect reference to a fullname stored in symbol table.
Class ​Import​From from m import x [as y], ...
Class ​Index​Expr Index expression x[y].
Class ​Int​Expr Integer literal
Class ​Lambda​Expr Lambda expression
Class ​List​Comprehension List comprehension (e.g. [x + 1 for x in a])
Class ​List​Expr List literal expression [...].
Class ​Member​Expr Member access expression x.y
Class ​Mypy​File The abstract syntax tree of a single source file.
Class ​Named​Tuple​Expr Named tuple expression namedtuple(...) or NamedTuple(...).
Class ​Name​Expr Name expression
Class ​New​Type​Expr NewType expression NewType(...).
Class ​Node Common base class for all non-type parse tree nodes.
Class ​Nonlocal​Decl Declaration nonlocal x, y, ...
Class ​Operator​Assignment​Stmt Operator assignment statement such as x += 1
Class ​Op​Expr Binary operation (other than . or [] or comparison operators, which have specific nodes).
Class ​Overloaded​Func​Def A logical node representing all the variants of a multi-declaration function.
Class ​Param​Spec​Expr Undocumented
Class ​Pass​Stmt Undocumented
Class ​Placeholder​Node Temporary symbol node that will later become a real SymbolNode.
Class ​Print​Stmt Python 2 print statement
Class ​Promote​Expr Ducktype class decorator expression _promote(...).
Class ​Raise​Stmt Undocumented
Class ​Ref​Expr Abstract base class for name-like constructs
Class ​Return​Stmt Undocumented
Class ​Reveal​Expr Reveal type expression reveal_type(expr) or reveal_locals() expression.
Class ​Set​Comprehension Set comprehension (e.g. {x + 1 for x in a})
Class ​Set​Expr Set literal expression {value, ...}.
Class ​Slice​Expr Slice expression (e.g. 'x:y', 'x:', '::2' or ':').
Class ​Star​Expr Star expression
Class ​Statement A statement node.
Class ​Str​Expr String literal
Class ​Super​Expr Expression super().name
Class ​Symbol​Node Nodes that can be stored in a symbol table.
Class ​Symbol​Table Static representation of a namespace dictionary.
Class ​Symbol​Table​Node Description of a name binding in a symbol table.
Class ​Temp​Node Temporary dummy node used during type checking.
Class ​Try​Stmt Undocumented
Class ​Tuple​Expr Tuple literal expression (..., ...)
Class ​Type​Alias A symbol node representing a type alias.
Class ​Type​Alias​Expr Type alias expression (rvalue).
Class ​Type​Application Type application expr[type, ...]
Class ​Typed​Dict​Expr Typed dict expression TypedDict(...).
Class ​Type​Info The type structure of a single class.
Class ​Type​Var​Expr Type variable expression TypeVar(...).
Class ​Type​Var​Like​Expr Base class for TypeVarExpr and ParamSpecExpr.
Class ​Unary​Expr Unary operation
Class ​Unicode​Expr Unicode literal (Python 2.x)
Class ​Var A variable.
Class ​While​Stmt Undocumented
Class ​With​Stmt Undocumented
Class ​Yield​Expr Undocumented
Class ​Yield​From​Expr Undocumented
Function check​_arg​_kinds Undocumented
Function check​_arg​_names Undocumented
Function get​_flags Undocumented
Function get​_member​_expr​_fullname Return the qualified name representation of a member expression.
Function get​_nongen​_builtins Undocumented
Function is​_class​_var Return whether the expression is ClassVar[...]
Function is​_final​_node Check whether node corresponds to a final attribute.
Function local​_definitions Iterate over local definitions (not imported) in a symbol table.
Function set​_flags Undocumented
Constant CLASSDEF​_NO​_INFO Undocumented
Constant CONTRAVARIANT Undocumented
Constant COVARIANT Undocumented
Constant deserialize​_map Undocumented
Constant FUNC​_NO​_INFO Undocumented
Constant FUNCBASE​_FLAGS Undocumented
Constant FUNCDEF​_FLAGS Undocumented
Constant FUNCITEM​_FLAGS Undocumented
Constant GDEF Undocumented
Constant implicit​_module​_attrs Undocumented
Constant INVARIANT Undocumented
Constant inverse​_node​_kinds Undocumented
Constant LDEF Undocumented
Constant LITERAL​_NO Undocumented
Constant LITERAL​_TYPE Undocumented
Constant LITERAL​_YES Undocumented
Constant MDEF Undocumented
Constant node​_kinds Undocumented
Constant REVEAL​_LOCALS Undocumented
Constant REVEAL​_TYPE Undocumented
Constant reverse​_builtin​_aliases Undocumented
Constant RUNTIME​_PROTOCOL​_DECOS Undocumented
Constant SYMBOL​_FUNCBASE​_TYPES Undocumented
Constant T Undocumented
Constant type​_aliases Undocumented
Constant type​_aliases​_source​_versions Undocumented
Constant typing​_extensions​_aliases Undocumented
Constant UNBOUND​_IMPORTED Undocumented
Constant VAR​_FLAGS Undocumented
Constant VAR​_NO​_INFO Undocumented
Variable ​Definition Undocumented
Variable ​Json​Dict Undocumented
Variable ​Overload​Part Undocumented
Constant _nongen​_builtins Undocumented
def check_arg_kinds(arg_kinds, nodes, fail): (source)

Undocumented

Parameters
arg​_kinds:List[ArgKind]Undocumented
nodes:List[T]Undocumented
fail:Callable[[str, T], None]Undocumented
def check_arg_names(names, nodes, fail, description='function definition'): (source)

Undocumented

Parameters
names:Sequence[Optional[str]]Undocumented
nodes:List[T]Undocumented
fail:Callable[[str, T], None]Undocumented
description:strUndocumented
def get_flags(node, names): (source)

Undocumented

Parameters
node:NodeUndocumented
names:List[str]Undocumented
Returns
List[str]Undocumented
def get_member_expr_fullname(expr): (source)

Return the qualified name representation of a member expression.

Return a string of form foo.bar, foo.bar.baz, or similar, or None if the argument cannot be represented in this form.

Parameters
expr:MemberExprUndocumented
Returns
Optional[str]Undocumented
def get_nongen_builtins(python_version): (source)

Undocumented

Parameters
python​_version:Tuple[int, int]Undocumented
Returns
Dict[str, str]Undocumented
def is_class_var(expr): (source)
Return whether the expression is ClassVar[...]
Parameters
expr:NameExprUndocumented
Returns
boolUndocumented
def is_final_node(node): (source)
Check whether node corresponds to a final attribute.
Parameters
node:Optional[SymbolNode]Undocumented
Returns
boolUndocumented
def local_definitions(names, name_prefix, info=None): (source)

Iterate over local definitions (not imported) in a symbol table.

Recursively iterate over class members and nested classes.

Parameters
names:SymbolTableUndocumented
name​_prefix:strUndocumented
info:Optional[TypeInfo]Undocumented
Returns
Iterator[Definition]Undocumented
def set_flags(node, flags): (source)

Undocumented

Parameters
node:NodeUndocumented
flags:List[str]Undocumented
CLASSDEF_NO_INFO: TypeInfo = (source)

Undocumented

Value
FakeInfo('ClassDef is lacking info')
CONTRAVARIANT: int = (source)

Undocumented

Value
2
COVARIANT: int = (source)

Undocumented

Value
1
deserialize_map = (source)

Undocumented

Value
{key: obj.deserialize for key, obj in globals().items() if type(obj) is not
    FakeInfo and isinstance(obj, type) and issubclass(obj, SymbolNode) and 
    obj is not SymbolNode}
FUNC_NO_INFO: TypeInfo = (source)

Undocumented

Value
FakeInfo('FuncBase for non-methods lack info')
FUNCBASE_FLAGS: list[str] = (source)

Undocumented

Value
['is_property', 'is_class', 'is_static', 'is_final']
FUNCDEF_FLAGS = (source)

Undocumented

Value
FUNCITEM_FLAGS+['is_decorated', 'is_conditional', 'is_abstract']
FUNCITEM_FLAGS = (source)

Undocumented

Value
FUNCBASE_FLAGS+['is_overload',
                'is_generator',
                'is_coroutine',
                'is_async_generator',
                'is_awaitable_coroutine']
GDEF: int = (source)

Undocumented

Value
1
implicit_module_attrs: dict = (source)

Undocumented

Value
{'__name__': '__builtins__.str',
 '__doc__': None,
 '__path__': None,
 '__file__': '__builtins__.str',
 '__package__': '__builtins__.str'}
INVARIANT: int = (source)

Undocumented

Value
0
inverse_node_kinds = (source)

Undocumented

Value
{_kind: _name for _name, _kind in node_kinds.items()}
LDEF: int = (source)

Undocumented

Value
0
LITERAL_NO: int = (source)

Undocumented

Value
0
LITERAL_TYPE: int = (source)

Undocumented

Value
1
LITERAL_YES: int = (source)

Undocumented

Value
2
MDEF: int = (source)

Undocumented

Value
2
node_kinds = (source)

Undocumented

Value
{LDEF: 'Ldef', GDEF: 'Gdef', MDEF: 'Mdef', UNBOUND_IMPORTED: 'UnboundImported'}
REVEAL_LOCALS: int = (source)

Undocumented

Value
1
REVEAL_TYPE: int = (source)

Undocumented

Value
0
reverse_builtin_aliases: dict[str, str] = (source)

Undocumented

Value
{'builtins.list': 'typing.List',
 'builtins.dict': 'typing.Dict',
 'builtins.set': 'typing.Set',
 'builtins.frozenset': 'typing.FrozenSet'}
RUNTIME_PROTOCOL_DECOS: tuple[str, ...] = (source)

Undocumented

Value
('typing.runtime_checkable',
 'typing_extensions.runtime',
 'typing_extensions.runtime_checkable')
SYMBOL_FUNCBASE_TYPES = (source)

Undocumented

Value
(OverloadedFuncDef, FuncDef)
T = (source)

Undocumented

Value
TypeVar('T')
type_aliases: dict[str, str] = (source)

Undocumented

Value
{'typing.List': 'builtins.list',
 'typing.Dict': 'builtins.dict',
 'typing.Set': 'builtins.set',
 'typing.FrozenSet': 'builtins.frozenset',
 'typing.ChainMap': 'collections.ChainMap',
 'typing.Counter': 'collections.Counter',
 'typing.DefaultDict': 'collections.defaultdict',
...
type_aliases_source_versions: dict = (source)

Undocumented

Value
{'typing.List': (2, 7),
 'typing.Dict': (2, 7),
 'typing.Set': (2, 7),
 'typing.FrozenSet': (2, 7),
 'typing.ChainMap': (3, 3),
 'typing.Counter': (2, 7),
 'typing.DefaultDict': (2, 7),
...
typing_extensions_aliases: dict[str, str] = (source)

Undocumented

Value
{'typing_extensions.OrderedDict': 'collections.OrderedDict'}
UNBOUND_IMPORTED: int = (source)

Undocumented

Value
3
VAR_FLAGS: list[str] = (source)

Undocumented

Value
['is_self',
 'is_initialized_in_class',
 'is_staticmethod',
 'is_classmethod',
 'is_property',
 'is_settable_property',
 'is_suppressed_import',
...
VAR_NO_INFO: TypeInfo = (source)

Undocumented

Value
FakeInfo('Var is lacking info')
Definition: _TypeAlias = (source)

Undocumented

JsonDict: _TypeAlias = (source)

Undocumented

OverloadPart: _TypeAlias = (source)

Undocumented

_nongen_builtins: dict[str, str] = (source)

Undocumented

Value
{'builtins.tuple': 'typing.Tuple', 'builtins.enumerate': ''}