Nodes

For a list of available nodes see Nodes.

Nodes

astroid.nodes.AnnAssign([lineno, ...])

Class representing an ast.AnnAssign node.

astroid.nodes.Arguments([vararg, kwarg, parent])

Class representing an ast.arguments node.

astroid.nodes.Assert([lineno, col_offset, ...])

Class representing an ast.Assert node.

astroid.nodes.Assign([lineno, col_offset, ...])

Class representing an ast.Assign node.

astroid.nodes.AssignAttr([attrname, lineno, ...])

Variation of ast.Assign representing assignment to an attribute.

astroid.nodes.AssignName([name, lineno, ...])

Variation of ast.Assign representing assignment to a name.

astroid.nodes.AsyncFor([lineno, col_offset, ...])

Class representing an ast.AsyncFor node.

astroid.nodes.AsyncFunctionDef([name, doc, ...])

Class representing an ast.FunctionDef node.

astroid.nodes.AsyncWith([lineno, ...])

Asynchronous with built with the async keyword.

astroid.nodes.Attribute([attrname, lineno, ...])

Class representing an ast.Attribute node.

astroid.nodes.AugAssign([op, lineno, ...])

Class representing an ast.AugAssign node.

astroid.nodes.Await([lineno, col_offset, ...])

Class representing an ast.Await node.

astroid.nodes.BinOp([op, lineno, ...])

Class representing an ast.BinOp node.

astroid.nodes.BoolOp([op, lineno, ...])

Class representing an ast.BoolOp node.

astroid.nodes.Break([lineno, col_offset, ...])

Class representing an ast.Break node.

astroid.nodes.Call([lineno, col_offset, ...])

Class representing an ast.Call node.

astroid.nodes.ClassDef([name, doc, lineno, ...])

Class representing an ast.ClassDef node.

astroid.nodes.Compare([lineno, col_offset, ...])

Class representing an ast.Compare node.

astroid.nodes.Comprehension([parent])

Class representing an ast.comprehension node.

astroid.nodes.Const(value[, lineno, ...])

Class representing any constant including num, str, bool, None, bytes.

astroid.nodes.Continue([lineno, col_offset, ...])

Class representing an ast.Continue node.

astroid.nodes.Decorators([lineno, ...])

A node representing a list of decorators.

astroid.nodes.DelAttr([attrname, lineno, ...])

Variation of ast.Delete representing deletion of an attribute.

astroid.nodes.DelName([name, lineno, ...])

Variation of ast.Delete representing deletion of a name.

astroid.nodes.Delete([lineno, col_offset, ...])

Class representing an ast.Delete node.

astroid.nodes.Dict([lineno, col_offset, ...])

Class representing an ast.Dict node.

astroid.nodes.DictComp([lineno, col_offset, ...])

Class representing an ast.DictComp node.

astroid.nodes.DictUnpack([lineno, ...])

Represents the unpacking of dicts into dicts using PEP 448.

astroid.nodes.Ellipsis([lineno, col_offset, ...])

Class representing an ast.Ellipsis node.

astroid.nodes.EmptyNode([lineno, ...])

Holds an arbitrary object in the LocalsDictNodeNG.locals.

astroid.nodes.ExceptHandler([lineno, ...])

Class representing an ast.ExceptHandler.

astroid.nodes.Expr([lineno, col_offset, ...])

Class representing an ast.Expr node.

astroid.nodes.ExtSlice([lineno, col_offset, ...])

Class representing an ast.ExtSlice node.

astroid.nodes.For([lineno, col_offset, ...])

Class representing an ast.For node.

astroid.nodes.FormattedValue([lineno, ...])

Class representing an ast.FormattedValue node.

astroid.nodes.FunctionDef([name, doc, ...])

Class representing an ast.FunctionDef.

astroid.nodes.GeneratorExp([lineno, ...])

Class representing an ast.GeneratorExp node.

astroid.nodes.Global(names[, lineno, ...])

Class representing an ast.Global node.

astroid.nodes.If([lineno, col_offset, ...])

Class representing an ast.If node.

astroid.nodes.IfExp([lineno, col_offset, ...])

Class representing an ast.IfExp node.

astroid.nodes.Import([names, lineno, ...])

Class representing an ast.Import node.

astroid.nodes.ImportFrom(fromname, names[, ...])

Class representing an ast.ImportFrom node.

astroid.nodes.Index([lineno, col_offset, ...])

Class representing an ast.Index node.

astroid.nodes.JoinedStr([lineno, ...])

Represents a list of string expressions to be joined.

astroid.nodes.Keyword([arg, lineno, ...])

Class representing an ast.keyword node.

astroid.nodes.Lambda([lineno, col_offset, ...])

Class representing an ast.Lambda node.

astroid.nodes.List([ctx, lineno, ...])

Class representing an ast.List node.

astroid.nodes.ListComp([lineno, col_offset, ...])

Class representing an ast.ListComp node.

astroid.nodes.Match([lineno, col_offset, ...])

Class representing a ast.Match node.

astroid.nodes.MatchAs([lineno, col_offset, ...])

Class representing a ast.MatchAs node.

astroid.nodes.MatchCase(*[, parent])

Class representing a ast.match_case node.

astroid.nodes.MatchClass([lineno, ...])

Class representing a ast.MatchClass node.

astroid.nodes.MatchMapping([lineno, ...])

Class representing a ast.MatchMapping node.

astroid.nodes.MatchOr([lineno, col_offset, ...])

Class representing a ast.MatchOr node.

astroid.nodes.MatchSequence([lineno, ...])

Class representing a ast.MatchSequence node.

astroid.nodes.MatchSingleton(*, value[, ...])

Class representing a ast.MatchSingleton node.

astroid.nodes.MatchStar([lineno, ...])

Class representing a ast.MatchStar node.

astroid.nodes.MatchValue([lineno, ...])

Class representing a ast.MatchValue node.

astroid.nodes.Module(name[, doc, file, ...])

Class representing an ast.Module node.

astroid.nodes.Name([name, lineno, ...])

Class representing an ast.Name node.

astroid.nodes.Nonlocal(names[, lineno, ...])

Class representing an ast.Nonlocal node.

astroid.nodes.Pass([lineno, col_offset, ...])

Class representing an ast.Pass node.

astroid.nodes.Raise([lineno, col_offset, ...])

Class representing an ast.Raise node.

astroid.nodes.Return([lineno, col_offset, ...])

Class representing an ast.Return node.

astroid.nodes.Set([lineno, col_offset, ...])

Class representing an ast.Set node.

astroid.nodes.SetComp([lineno, col_offset, ...])

Class representing an ast.SetComp node.

astroid.nodes.Slice([lineno, col_offset, ...])

Class representing an ast.Slice node.

astroid.nodes.Starred([ctx, lineno, ...])

Class representing an ast.Starred node.

astroid.nodes.Subscript([ctx, lineno, ...])

Class representing an ast.Subscript node.

astroid.nodes.TryExcept([lineno, ...])

Class representing an ast.TryExcept node.

astroid.nodes.TryFinally([lineno, ...])

Class representing an ast.TryFinally node.

astroid.nodes.Tuple([ctx, lineno, ...])

Class representing an ast.Tuple node.

astroid.nodes.UnaryOp([op, lineno, ...])

Class representing an ast.UnaryOp node.

astroid.nodes.Unknown([lineno, col_offset, ...])

This node represents a node in a constructed AST where introspection is not possible.

astroid.nodes.While([lineno, col_offset, ...])

Class representing an ast.While node.

astroid.nodes.With([lineno, col_offset, ...])

Class representing an ast.With node.

astroid.nodes.Yield([lineno, col_offset, ...])

Class representing an ast.Yield node.

astroid.nodes.YieldFrom([lineno, ...])

Class representing an ast.YieldFrom node.
class astroid.nodes.AnnAssign(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.AssignTypeMixin, astroid.nodes.node_classes.Statement

Class representing an ast.AnnAssign node.

An AnnAssign is an assignment with a type annotation.

>>> import astroid
>>> node = astroid.extract_node('variable: List[int] = range(10)')
>>> node
<AnnAssign l.1 at 0x7effe1d4c630>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

assigned_stmts(node=None, context=None, assign_path=None)

Returns the assigned statement (non inferred) according to the assignment type. See astroid/protocols.py for actual implementation.

Parameters
Return type

Any

get_children()[source]

Get the child nodes below this node.

postinit(target, annotation, simple, value=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

annotation: Optional[NodeNG]

The type annotation of what is being assigned to.

simple: Optional[int]

Whether target is a pure name or a complex statement.

target: Optional[NodeNG]

What is being assigned to.

value: Optional[NodeNG]

The value being assigned to the variables.

class astroid.nodes.Arguments(vararg=None, kwarg=None, parent=None)[source]

Bases: astroid.mixins.AssignTypeMixin, astroid.nodes.node_ng.NodeNG

Class representing an ast.arguments node.

An Arguments node represents that arguments in a function definition.

>>> import astroid
>>> node = astroid.extract_node('def foo(bar): pass')
>>> node
<FunctionDef.foo l.1 at 0x7effe1db8198>
>>> node.args
<Arguments l.1 at 0x7effe1db82e8>
Parameters

  • vararg (Optional[str]) – The name of the variable length arguments.

  • kwarg (Optional[str]) – The name of the variable length keyword arguments.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

Return type

None

assigned_stmts(node=None, context=None, assign_path=None)

Returns the assigned statement (non inferred) according to the assignment type. See astroid/protocols.py for actual implementation.

Parameters
Return type

Any

default_value(argname)[source]

Get the default value for an argument.

Parameters

argname (str) – The name of the argument to get the default value for.

Raises

NoDefault – If there is no default value defined for the given argument.

find_argname(argname, rec=False)[source]

Get the index and AssignName node for given name.

Parameters

  • argname (str) – The name of the argument to search for.

  • rec (bool) – Whether or not to include arguments in unpacked tuples in the search.

Returns

The index and node for the argument.

Return type

tuple(str or None, AssignName or None)

format_args()[source]

Get the arguments formatted as string.

Returns

The formatted arguments.

Return type

str

get_children()[source]

Get the child nodes below this node.

is_argument(name)[source]

Check if the given name is defined in the arguments.

Parameters

name (str) – The name to check for.

Returns

True if the given name is defined in the arguments, False otherwise.

Return type

bool

postinit(args, defaults, kwonlyargs, kw_defaults, annotations, posonlyargs=None, kwonlyargs_annotations=None, posonlyargs_annotations=None, varargannotation=None, kwargannotation=None, type_comment_args=None, type_comment_kwonlyargs=None, type_comment_posonlyargs=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

annotations: List[Optional[NodeNG]]

The type annotations of arguments that can be passed positionally.

args: Optional[List[AssignName]]

The names of the required arguments.

Can be None if the associated function does not have a retrievable signature and the arguments are therefore unknown. This happens with builtin functions implemented in C.

arguments

<wrapped by the cachedproperty decorator> Get all the arguments for this node, including positional only and positional and keyword

col_offset: None

The column that this node appears on in the source code.

defaults: List[NodeNG]

The default values for arguments that can be passed positionally.

end_col_offset: None

The end column this node appears on in the source code. Note: This is after the last symbol.

end_lineno: None

The last line this node appears on in the source code.

fromlineno

<wrapped by the cachedproperty decorator> The first line that this node appears on in the source code.

type

int or None

kw_defaults: List[Optional[NodeNG]]

The default values for keyword arguments that cannot be passed positionally.

kwarg: Optional[str]

The name of the variable length keyword arguments.

kwargannotation: Optional[NodeNG]

The type annotation for the variable length keyword arguments.

kwonlyargs: List[AssignName]

The keyword arguments that cannot be passed positionally.

kwonlyargs_annotations: List[Optional[NodeNG]]

The type annotations of arguments that cannot be passed positionally.

lineno: None

The line that this node appears on in the source code.

posonlyargs: List[AssignName]

The arguments that can only be passed positionally.

posonlyargs_annotations: List[Optional[NodeNG]]

The type annotations of arguments that can only be passed positionally.

type_comment_args: List[Optional[NodeNG]]

The type annotation, passed by a type comment, of each argument.

If an argument does not have a type comment, the value for that argument will be None.

type_comment_kwonlyargs: List[Optional[NodeNG]]

The type annotation, passed by a type comment, of each keyword only argument.

If an argument does not have a type comment, the value for that argument will be None.

type_comment_posonlyargs: List[Optional[NodeNG]]

The type annotation, passed by a type comment, of each positional argument.

If an argument does not have a type comment, the value for that argument will be None.

vararg: Optional[str]

The name of the variable length arguments.

varargannotation: Optional[NodeNG]

The type annotation for the variable length arguments.

class astroid.nodes.Assert(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_classes.Statement

Class representing an ast.Assert node.

An Assert node represents an assert statement.

>>> import astroid
>>> node = astroid.extract_node('assert len(things) == 10, "Not enough things"')
>>> node
<Assert l.1 at 0x7effe1d527b8>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

postinit(test=None, fail=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

fail: Optional[NodeNG]

The message shown when the assertion fails.

test: Optional[NodeNG]

The test that passes or fails the assertion.

class astroid.nodes.Assign(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.AssignTypeMixin, astroid.nodes.node_classes.Statement

Class representing an ast.Assign node.

An Assign is a statement where something is explicitly asssigned to.

>>> import astroid
>>> node = astroid.extract_node('variable = range(10)')
>>> node
<Assign l.1 at 0x7effe1db8550>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

assigned_stmts(node=None, context=None, assign_path=None)

Returns the assigned statement (non inferred) according to the assignment type. See astroid/protocols.py for actual implementation.

Parameters
Return type

Any

get_children()[source]

Get the child nodes below this node.

postinit(targets=None, value=None, type_annotation=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

targets: List[NodeNG]

What is being assigned to.

type_annotation: Optional[NodeNG]

If present, this will contain the type annotation passed by a type comment

value: Optional[NodeNG]

The value being assigned to the variables.

class astroid.nodes.AssignAttr(attrname=None, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.ParentAssignTypeMixin, astroid.nodes.node_ng.NodeNG

Variation of ast.Assign representing assignment to an attribute.

>>> import astroid
>>> node = astroid.extract_node('self.attribute = range(10)')
>>> node
<Assign l.1 at 0x7effe1d521d0>
>>> list(node.get_children())
[<AssignAttr.attribute l.1 at 0x7effe1d52320>, <Call l.1 at 0x7effe1d522e8>]
>>> list(node.get_children())[0].as_string()
'self.attribute'
Parameters

  • attrname (Optional[str]) – The name of the attribute being assigned to.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

assigned_stmts(node=None, context=None, assign_path=None)

Returns the assigned statement (non inferred) according to the assignment type. See astroid/protocols.py for actual implementation.

Parameters
Return type

Any

get_children()[source]

Get the child nodes below this node.

infer_lhs(context=None)

infer an Attribute node by using getattr on the associated object

postinit(expr=None)[source]

Do some setup after initialisation.

Parameters

expr (Optional[astroid.nodes.node_ng.NodeNG]) – What has the attribute that is being assigned to.

Return type

None

attrname: Optional[str]

The name of the attribute being assigned to.

expr: Optional[NodeNG]

What has the attribute that is being assigned to.

class astroid.nodes.AssignName(name=None, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.NoChildrenMixin, astroid.nodes.node_classes.LookupMixIn, astroid.mixins.ParentAssignTypeMixin, astroid.nodes.node_ng.NodeNG

Variation of ast.Assign representing assignment to a name.

An AssignName is the name of something that is assigned to. This includes variables defined in a function signature or in a loop.

>>> import astroid
>>> node = astroid.extract_node('variable = range(10)')
>>> node
<Assign l.1 at 0x7effe1db8550>
>>> list(node.get_children())
[<AssignName.variable l.1 at 0x7effe1db8748>, <Call l.1 at 0x7effe1db8630>]
>>> list(node.get_children())[0].as_string()
'variable'
Parameters

  • name (Optional[str]) – The name that is assigned to.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

assigned_stmts(node=None, context=None, assign_path=None)

Returns the assigned statement (non inferred) according to the assignment type. See astroid/protocols.py for actual implementation.

Parameters
Return type

Any

infer_lhs(context=None)

infer a Name: use name lookup rules

name: Optional[str]

The name that is assigned to.

class astroid.nodes.AsyncFor(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_classes.For

Class representing an ast.AsyncFor node.

An AsyncFor is an asynchronous For built with the async keyword.

>>> import astroid
>>> node = astroid.extract_node('''
async def func(things):
    async for thing in things:
        print(thing)
''')
>>> node
<AsyncFunctionDef.func l.2 at 0x7f23b2e416d8>
>>> node.body[0]
<AsyncFor l.3 at 0x7f23b2e417b8>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

class astroid.nodes.AsyncFunctionDef(name=None, doc=None, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.scoped_nodes.scoped_nodes.FunctionDef

Class representing an ast.FunctionDef node.

A AsyncFunctionDef is an asynchronous function created with the async keyword.

>>> import astroid
>>> node = astroid.extract_node('''
async def func(things):
    async for thing in things:
        print(thing)
''')
>>> node
<AsyncFunctionDef.func l.2 at 0x7f23b2e416d8>
>>> node.body[0]
<AsyncFor l.3 at 0x7f23b2e417b8>
Parameters

  • name (str or None) – The name of the function.

  • doc (Optional[str]) – The function docstring.

  • lineno (int or None) – The line that this node appears on in the source code.

  • col_offset (int or None) – The column that this node appears on in the source code.

  • parent (NodeNG or None) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

class astroid.nodes.AsyncWith(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_classes.With

Asynchronous with built with the async keyword.

Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

class astroid.nodes.Attribute(attrname=None, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_ng.NodeNG

Class representing an ast.Attribute node.

Parameters

  • attrname (Optional[str]) – The name of the attribute.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

postinit(expr=None)[source]

Do some setup after initialisation.

Parameters

expr (Name or None) – The name that this node represents.

Return type

None

attrname: Optional[str]

The name of the attribute.

expr: Optional[NodeNG]

The name that this node represents.

Type

Name or None

class astroid.nodes.AugAssign(op=None, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.AssignTypeMixin, astroid.nodes.node_classes.Statement

Class representing an ast.AugAssign node.

An AugAssign is an assignment paired with an operator.

>>> import astroid
>>> node = astroid.extract_node('variable += 1')
>>> node
<AugAssign l.1 at 0x7effe1db4d68>
Parameters

  • op (Optional[str]) – The operator that is being combined with the assignment. This includes the equals sign.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

assigned_stmts(node=None, context=None, assign_path=None)

Returns the assigned statement (non inferred) according to the assignment type. See astroid/protocols.py for actual implementation.

Parameters
Return type

Any

get_children()[source]

Get the child nodes below this node.

postinit(target=None, value=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

type_errors(context=None)[source]

Get a list of type errors which can occur during inference.

Each TypeError is represented by a BadBinaryOperationMessage , which holds the original exception.

Returns

The list of possible type errors.

Return type

list(BadBinaryOperationMessage)

op: Optional[str]

The operator that is being combined with the assignment.

This includes the equals sign.

target: Optional[NodeNG]

What is being assigned to.

value: Optional[NodeNG]

The value being assigned to the variable.

class astroid.nodes.Await(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_ng.NodeNG

Class representing an ast.Await node.

An Await is the await keyword.

>>> import astroid
>>> node = astroid.extract_node('''
async def func(things):
    await other_func()
''')
>>> node
<AsyncFunctionDef.func l.2 at 0x7f23b2e41748>
>>> node.body[0]
<Expr l.3 at 0x7f23b2e419e8>
>>> list(node.body[0].get_children())[0]
<Await l.3 at 0x7f23b2e41a20>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

postinit(value=None)[source]

Do some setup after initialisation.

Parameters

value (Optional[astroid.nodes.node_ng.NodeNG]) – What to wait for.

Return type

None

value: Optional[NodeNG]

What to wait for.

class astroid.nodes.BinOp(op=None, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_ng.NodeNG

Class representing an ast.BinOp node.

A BinOp node is an application of a binary operator.

>>> import astroid
>>> node = astroid.extract_node('a + b')
>>> node
<BinOp l.1 at 0x7f23b2e8cfd0>
Parameters

  • op (Optional[str]) – The operator.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

op_left_associative()[source]
op_precedence()[source]
postinit(left=None, right=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

type_errors(context=None)[source]

Get a list of type errors which can occur during inference.

Each TypeError is represented by a BadBinaryOperationMessage, which holds the original exception.

Returns

The list of possible type errors.

Return type

list(BadBinaryOperationMessage)

left: Optional[NodeNG]

What is being applied to the operator on the left side.

op: Optional[str]

The operator.

right: Optional[NodeNG]

What is being applied to the operator on the right side.

class astroid.nodes.BoolOp(op=None, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_ng.NodeNG

Class representing an ast.BoolOp node.

A BoolOp is an application of a boolean operator.

>>> import astroid
>>> node = astroid.extract_node('a and b')
>>> node
<BinOp l.1 at 0x7f23b2e71c50>
Parameters

  • op (Optional[str]) – The operator.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

op_precedence()[source]
postinit(values=None)[source]

Do some setup after initialisation.

Parameters

values (Optional[List[astroid.nodes.node_ng.NodeNG]]) – The values being applied to the operator.

Return type

None

op: Optional[str]

The operator.

values: List[NodeNG]

The values being applied to the operator.

class astroid.nodes.Break(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.NoChildrenMixin, astroid.nodes.node_classes.Statement

Class representing an ast.Break node.

>>> import astroid
>>> node = astroid.extract_node('break')
>>> node
<Break l.1 at 0x7f23b2e9e5c0>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

class astroid.nodes.Call(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_ng.NodeNG

Class representing an ast.Call node.

A Call node is a call to a function, method, etc.

>>> import astroid
>>> node = astroid.extract_node('function()')
>>> node
<Call l.1 at 0x7f23b2e71eb8>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

postinit(func=None, args=None, keywords=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

args: List[NodeNG]

The positional arguments being given to the call.

func: Optional[NodeNG]

What is being called.

keywords: List['Keyword']

The keyword arguments being given to the call.

property kwargs: List[astroid.nodes.node_classes.Keyword]

The keyword arguments that unpack something.

property starargs: List[astroid.nodes.node_classes.Starred]

The positional arguments that unpack something.

class astroid.nodes.ClassDef(name=None, doc=None, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.FilterStmtsMixin, astroid.nodes.scoped_nodes.mixin.LocalsDictNodeNG, astroid.nodes.node_classes.Statement

Class representing an ast.ClassDef node.

>>> import astroid
>>> node = astroid.extract_node('''
class Thing:
    def my_meth(self, arg):
        return arg + self.offset
''')
>>> node
<ClassDef.Thing l.2 at 0x7f23b2e9e748>
Parameters

  • name (str or None) – The name of the class.

  • doc (Optional[str]) – The class docstring.

  • lineno (int or None) – The line that this node appears on in the source code.

  • col_offset (int or None) – The column that this node appears on in the source code.

  • parent (NodeNG or None) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

ancestors(recurs=True, context=None)[source]

Iterate over the base classes in prefixed depth first order.

Parameters

recurs (bool) – Whether to recurse or return direct ancestors only.

Returns

The base classes

Return type

iterable(NodeNG)

block_range(lineno)[source]

Get a range from the given line number to where this node ends.

Parameters

lineno (int) – Unused.

Returns

The range of line numbers that this node belongs to,

Return type

tuple(int, int)

bool_value(context=None)[source]

Determine the boolean value of this node.

Returns

The boolean value of this node. For a ClassDef this is always True.

Return type

bool

callable()[source]

Whether this node defines something that is callable.

Returns

True if this defines something that is callable, False otherwise. For a ClassDef this is always True.

Return type

bool

declared_metaclass(context=None)[source]

Return the explicit declared metaclass for the current class.

An explicit declared metaclass is defined either by passing the metaclass keyword argument in the class definition line (Python 3) or (Python 2) by having a __metaclass__ class attribute, or if there are no explicit bases but there is a global __metaclass__ variable.

Returns

The metaclass of this class, or None if one could not be found.

Return type

NodeNG or None

display_type()[source]

A human readable type of this node.

Returns

The type of this node.

Return type

str

frame(*, future=None)[source]

The node’s frame node.

A frame node is a Module, FunctionDef, ClassDef or Lambda.

Returns

The node itself.

Parameters

  • self (astroid.nodes.scoped_nodes.scoped_nodes.T) –

  • future (Optional[typing_extensions.Literal[None, True]]) –

Return type

astroid.nodes.scoped_nodes.scoped_nodes.T

get_children()[source]

Get the child nodes below this node.

getattr(name, context=None, class_context=True)[source]

Get an attribute from this class, using Python’s attribute semantic.

This method doesn’t look in the instance_attrs dictionary since it is done by an Instance proxy at inference time. It may return an Uninferable object if the attribute has not been found, but a __getattr__ or __getattribute__ method is defined. If class_context is given, then it is considered that the attribute is accessed from a class context, e.g. ClassDef.attribute, otherwise it might have been accessed from an instance as well. If class_context is used in that case, then a lookup in the implicit metaclass and the explicit metaclass will be done.

Parameters

  • name (str) – The attribute to look for.

  • class_context (bool) – Whether the attribute can be accessed statically.

Returns

The attribute.

Return type

list(NodeNG)

Raises

AttributeInferenceError – If the attribute cannot be inferred.

getitem(index, context=None)[source]

Return the inference of a subscript.

This is basically looking up the method in the metaclass and calling it.

Returns

The inferred value of a subscript to this class.

Return type

NodeNG

Raises

AstroidTypeError – If this class does not define a __getitem__ method.

has_base(node)[source]

Whether this class directly inherits from the given node.

Parameters

node (NodeNG) – The node to check for.

Returns

True if this class directly inherits from the given node.

Return type

bool

has_dynamic_getattr(context=None)[source]

Check if the class has a custom __getattr__ or __getattribute__.

If any such method is found and it is not from builtins, nor from an extension module, then the function will return True.

Returns

True if the class has a custom __getattr__ or __getattribute__, False otherwise.

Return type

bool

has_metaclass_hack()[source]
igetattr(name, context=None, class_context=True)[source]

Infer the possible values of the given variable.

Parameters

name (str) – The name of the variable to infer.

Returns

The inferred possible values.

Return type

iterable(NodeNG or Uninferable)

implicit_locals()[source]

Get implicitly defined class definition locals.

Returns

the the name and Const pair for each local

Return type

tuple(tuple(str, node_classes.Const), …)

implicit_metaclass()[source]

Get the implicit metaclass of the current class.

For newstyle classes, this will return an instance of builtins.type. For oldstyle classes, it will simply return None, since there’s no implicit metaclass there.

Returns

The metaclass.

Return type

builtins.type or None

implicit_parameters()[source]
infer_binary_op(opnode, operator, other, context, method)
infer_call_result(caller, context=None)[source]

infer what a class is returning when called

instance_attr(name, context=None)[source]

Get the list of nodes associated to the given attribute name.

Assignments are looked for in both this class and in parents.

Returns

The list of assignments to the given name.

Return type

list(NodeNG)

Raises

AttributeInferenceError – If no attribute with this name can be found in this class or parent classes.

instance_attr_ancestors(name, context=None)[source]

Iterate over the parents that define the given name as an attribute.

Parameters

name (str) – The name to find definitions for.

Returns

The parents that define the given name as an instance attribute.

Return type

iterable(NodeNG)

instantiate_class()[source]

Get an Instance of the ClassDef node.

Returns

An Instance of the ClassDef node, or self if this is not possible.

Return type

Instance or ClassDef

is_subtype_of(type_name, context=None)[source]

Whether this class is a subtype of the given type.

Parameters

type_name (str) – The name of the type of check against.

Returns

True if this class is a subtype of the given type, False otherwise.

Return type

bool

local_attr(name, context=None)[source]

Get the list of assign nodes associated to the given name.

Assignments are looked for in both this class and in parents.

Returns

The list of assignments to the given name.

Return type

list(NodeNG)

Raises

AttributeInferenceError – If no attribute with this name can be found in this class or parent classes.

local_attr_ancestors(name, context=None)[source]

Iterate over the parents that define the given name.

Parameters

name (str) – The name to find definitions for.

Returns

The parents that define the given name.

Return type

iterable(NodeNG)

metaclass(context=None)[source]

Get the metaclass of this class.

If this class does not define explicitly a metaclass, then the first defined metaclass in ancestors will be used instead.

Returns

The metaclass of this class.

Return type

NodeNG or None

methods()[source]

Iterate over all of the method defined in this class and its parents.

Returns

The methods defined on the class.

Return type

iterable(FunctionDef)

mro(context=None)[source]

Get the method resolution order, using C3 linearization.

Returns

The list of ancestors, sorted by the mro.

Return type

list(NodeNG)

Raises
mymethods()[source]

Iterate over all of the method defined in this class only.

Returns

The methods defined on the class.

Return type

iterable(FunctionDef)

postinit(bases, body, decorators, newstyle=None, metaclass=None, keywords=None, *, position=None, doc_node=None)[source]

Do some setup after initialisation.

Parameters

  • bases (list(NodeNG)) – What the class inherits from.

  • body (list(NodeNG)) – The contents of the class body.

  • decorators (Decorators or None) – The decorators that are applied to this class.

  • newstyle (bool or None) – Whether this is a new style class or not.

  • metaclass (NodeNG or None) – The metaclass of this class.

  • keywords (list(Keyword) or None) – The keywords given to the class definition.

  • position (Optional[astroid.nodes.utils.Position]) – Position of class keyword and name.

  • doc_node (Optional[astroid.nodes.node_classes.Const]) – The doc node associated with this node.

pytype()[source]

Get the name of the type that this node represents.

Returns

The name of the type.

Return type

str

scope_lookup(node, name, offset=0)[source]

Lookup where the given name is assigned.

Parameters

  • node (NodeNG) – The node to look for assignments up to. Any assignments after the given node are ignored.

  • name (str) – The name to find assignments for.

  • offset (int) – The line offset to filter statements up to.

Returns

This scope node and the list of assignments associated to the given name according to the scope where it has been found (locals, globals or builtin).

Return type

tuple(str, list(NodeNG))

slots()[source]

Get all the slots for this node.

Returns

The names of slots for this class. If the class doesn’t define any slot, through the __slots__ variable, then this function will return a None. Also, it will return None in the case the slots were not inferred.

Return type

list(str) or None

property basenames

The names of the parent classes

Names are given in the order they appear in the class definition.

Type

list(str)

bases

What the class inherits from.

Type

list(NodeNG)

blockstart_tolineno

<wrapped by the cachedproperty decorator> The line on which the beginning of this block ends.

type

int

body

The contents of the class body.

Type

list(NodeNG)

decorators = None

The decorators that are applied to this class.

Type

Decorators or None

property doc: Optional[str]

The class docstring.

doc_node: Optional[Const]

The doc node associated with this node.

fromlineno

<wrapped by the cachedproperty decorator> The first line that this node appears on in the source code.

hide = False
is_dataclass: bool

Whether this class is a dataclass.

keywords

The keywords given to the class definition.

This is usually for PEP 3115 style metaclass declaration.

Type

list(Keyword) or None

name

The name of the class.

property newstyle

Whether this is a new style class or not

Type

bool or None

special_attributes

The names of special attributes that this class has.

Type

objectmodel.ClassModel

property type

The class type for this node.

Possible values are: class, metaclass, exception.

Type

str

class astroid.nodes.Compare(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_ng.NodeNG

Class representing an ast.Compare node.

A Compare node indicates a comparison.

>>> import astroid
>>> node = astroid.extract_node('a <= b <= c')
>>> node
<Compare l.1 at 0x7f23b2e9e6d8>
>>> node.ops
[('<=', <Name.b l.1 at 0x7f23b2e9e2b0>), ('<=', <Name.c l.1 at 0x7f23b2e9e390>)]
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

Overridden to handle the tuple fields and skip returning the operator strings.

Returns

The children.

Return type

iterable(NodeNG)

last_child()[source]

An optimized version of list(get_children())[-1]

Returns

The last child.

Return type

NodeNG

postinit(left=None, ops=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

left: Optional[NodeNG]

The value at the left being applied to a comparison operator.

ops: List[Tuple[str, NodeNG]]

The remainder of the operators and their relevant right hand value.

class astroid.nodes.Comprehension(parent=None)[source]

Bases: astroid.nodes.node_ng.NodeNG

Class representing an ast.comprehension node.

A Comprehension indicates the loop inside any type of comprehension including generator expressions.

>>> import astroid
>>> node = astroid.extract_node('[x for x in some_values]')
>>> list(node.get_children())
[<Name.x l.1 at 0x7f23b2e352b0>, <Comprehension l.1 at 0x7f23b2e35320>]
>>> list(node.get_children())[1].as_string()
'for x in some_values'
Parameters

parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

Return type

None

assign_type()[source]

The type of assignment that this node performs.

Returns

The assignment type.

Return type

NodeNG

assigned_stmts(node=None, context=None, assign_path=None)

Returns the assigned statement (non inferred) according to the assignment type. See astroid/protocols.py for actual implementation.

Parameters
Return type

Any

get_children()[source]

Get the child nodes below this node.

postinit(target=None, iter=None, ifs=None, is_async=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

col_offset: None

The column that this node appears on in the source code.

end_col_offset: None

The end column this node appears on in the source code. Note: This is after the last symbol.

end_lineno: None

The last line this node appears on in the source code.

ifs: List[NodeNG]

The contents of any if statements that filter the comprehension.

is_async: Optional[bool]

Whether this is an asynchronous comprehension or not.

iter: Optional[NodeNG]

What is iterated over by the comprehension.

lineno: None

The line that this node appears on in the source code.

optional_assign: ClassVar[bool] = True

Whether this node optionally assigns a variable.

target: Optional[NodeNG]

What is assigned to by the comprehension.

class astroid.nodes.Const(value, lineno=None, col_offset=None, parent=None, kind=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.NoChildrenMixin, astroid.nodes.node_ng.NodeNG, astroid.bases.Instance

Class representing any constant including num, str, bool, None, bytes.

>>> import astroid
>>> node = astroid.extract_node('(5, "This is a string.", True, None, b"bytes")')
>>> node
<Tuple.tuple l.1 at 0x7f23b2e358d0>
>>> list(node.get_children())
[<Const.int l.1 at 0x7f23b2e35940>,
<Const.str l.1 at 0x7f23b2e35978>,
<Const.bool l.1 at 0x7f23b2e359b0>,
<Const.NoneType l.1 at 0x7f23b2e359e8>,
<Const.bytes l.1 at 0x7f23b2e35a20>]
Parameters

  • value (Any) – The value that the constant represents.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • kind (Optional[str]) – The string prefix. “u” for u-prefixed strings and None otherwise. Python 3.8+ only.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

bool_value(context=None)[source]

Determine the boolean value of this node.

Returns

The boolean value of this node.

Return type

bool

getitem(index, context=None)[source]

Get an item from this node if subscriptable.

Parameters

index (Const or Slice) – The node to use as a subscript index.

Raises

AstroidTypeError – When the given index cannot be used as a subscript index, or if this node is not subscriptable.

has_dynamic_getattr()[source]

Check if the node has a custom __getattr__ or __getattribute__.

Returns

True if the class has a custom __getattr__ or __getattribute__, False otherwise. For a Const this is always False.

Return type

bool

infer_binary_op(opnode, operator, other, context, _)
infer_unary_op(op)
itered()[source]

An iterator over the elements this node contains.

Returns

The contents of this node.

Return type

iterable(Const)

Raises

TypeError – If this node does not represent something that is iterable.

pytype()[source]

Get the name of the type that this node represents.

Returns

The name of the type.

Return type

str

kind: Optional[str]

“The string prefix. “u” for u-prefixed strings and None otherwise. Python 3.8+ only.

value: Any

The value that the constant represents.

class astroid.nodes.Continue(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.NoChildrenMixin, astroid.nodes.node_classes.Statement

Class representing an ast.Continue node.

>>> import astroid
>>> node = astroid.extract_node('continue')
>>> node
<Continue l.1 at 0x7f23b2e35588>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

class astroid.nodes.Decorators(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_ng.NodeNG

A node representing a list of decorators.

A Decorators is the decorators that are applied to a method or function.

>>> import astroid
>>> node = astroid.extract_node('''
@property
def my_property(self):
    return 3
''')
>>> node
<FunctionDef.my_property l.2 at 0x7f23b2e35d30>
>>> list(node.get_children())[0]
<Decorators l.1 at 0x7f23b2e35d68>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

postinit(nodes)[source]

Do some setup after initialisation.

Parameters

nodes (list(Name or Call)) – The decorators that this node contains.

Return type

None

scope()[source]

The first parent node defining a new scope. These can be Module, FunctionDef, ClassDef, Lambda, or GeneratorExp nodes.

Returns

The first parent scope node.

Return type

LocalsDictNodeNG

nodes: List[NodeNG]

The decorators that this node contains.

Type

list(Name or Call) or None

class astroid.nodes.DelAttr(attrname=None, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.ParentAssignTypeMixin, astroid.nodes.node_ng.NodeNG

Variation of ast.Delete representing deletion of an attribute.

>>> import astroid
>>> node = astroid.extract_node('del self.attr')
>>> node
<Delete l.1 at 0x7f23b2e35f60>
>>> list(node.get_children())[0]
<DelAttr.attr l.1 at 0x7f23b2e411d0>
Parameters

  • attrname (Optional[str]) – The name of the attribute that is being deleted.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

postinit(expr=None)[source]

Do some setup after initialisation.

Parameters

expr (Name or None) – The name that this node represents.

Return type

None

attrname: Optional[str]

The name of the attribute that is being deleted.

expr: Optional[NodeNG]

The name that this node represents.

Type

Name or None

class astroid.nodes.DelName(name=None, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.NoChildrenMixin, astroid.nodes.node_classes.LookupMixIn, astroid.mixins.ParentAssignTypeMixin, astroid.nodes.node_ng.NodeNG

Variation of ast.Delete representing deletion of a name.

A DelName is the name of something that is deleted.

>>> import astroid
>>> node = astroid.extract_node("del variable #@")
>>> list(node.get_children())
[<DelName.variable l.1 at 0x7effe1da4d30>]
>>> list(node.get_children())[0].as_string()
'variable'
Parameters

  • name (Optional[str]) – The name that is being deleted.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

name: Optional[str]

The name that is being deleted.

class astroid.nodes.Delete(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.AssignTypeMixin, astroid.nodes.node_classes.Statement

Class representing an ast.Delete node.

A Delete is a del statement this is deleting something.

>>> import astroid
>>> node = astroid.extract_node('del self.attr')
>>> node
<Delete l.1 at 0x7f23b2e35f60>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

postinit(targets=None)[source]

Do some setup after initialisation.

Parameters

targets (Optional[List[astroid.nodes.node_ng.NodeNG]]) – What is being deleted.

Return type

None

targets: List[NodeNG]

What is being deleted.

class astroid.nodes.Dict(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_ng.NodeNG, astroid.objects.DictInstance

Class representing an ast.Dict node.

A Dict is a dictionary that is created with {} syntax.

>>> import astroid
>>> node = astroid.extract_node('{1: "1"}')
>>> node
<Dict.dict l.1 at 0x7f23b2e35cc0>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

bool_value(context=None)[source]

Determine the boolean value of this node.

Returns

The boolean value of this node.

Return type

bool

classmethod from_elements(items=None)[source]

Create a Dict of constants from a live dictionary.

Parameters

items (dict) – The items to store in the node.

Returns

The created dictionary node.

Return type

Dict

get_children()[source]

Get the key and value nodes below this node.

Children are returned in the order that they are defined in the source code, key first then the value.

Returns

The children.

Return type

iterable(NodeNG)

getitem(index, context=None)[source]

Get an item from this node.

Parameters

index (Const or Slice) – The node to use as a subscript index.

Raises

  • AstroidTypeError – When the given index cannot be used as a subscript index, or if this node is not subscriptable.

  • AstroidIndexError – If the given index does not exist in the dictionary.

infer_unary_op(op)
itered()[source]

An iterator over the keys this node contains.

Returns

The keys of this node.

Return type

iterable(NodeNG)

last_child()[source]

An optimized version of list(get_children())[-1]

Returns

The last child, or None if no children exist.

Return type

NodeNG or None

postinit(items)[source]

Do some setup after initialisation.

Parameters

items (List[Tuple[astroid.nodes.node_ng.NodeNG, astroid.nodes.node_ng.NodeNG]]) – The key-value pairs contained in the dictionary.

Return type

None

pytype()[source]

Get the name of the type that this node represents.

Returns

The name of the type.

Return type

str

items: List[Tuple[NodeNG, NodeNG]]

The key-value pairs contained in the dictionary.

class astroid.nodes.DictComp(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.scoped_nodes.mixin.ComprehensionScope

Class representing an ast.DictComp node.

>>> import astroid
>>> node = astroid.extract_node('{k:v for k, v in things if k > v}')
>>> node
<DictComp l.1 at 0x7f23b2e41d68>
Parameters

  • lineno (int or None) – The line that this node appears on in the source code.

  • col_offset (int or None) – The column that this node appears on in the source code.

  • parent (NodeNG or None) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

bool_value(context=None)[source]

Determine the boolean value of this node.

Returns

The boolean value of this node. For a DictComp this is always Uninferable.

Return type

Uninferable

get_children()[source]

Get the child nodes below this node.

postinit(key=None, value=None, generators=None)[source]

Do some setup after initialisation.

Parameters

  • key (NodeNG or None) – What produces the keys.

  • value (NodeNG or None) – What produces the values.

  • generators (list(Comprehension) or None) – The generators that are looped through.

generators = None

The generators that are looped through.

Type

list(Comprehension) or None

key = None

What produces the keys.

Type

NodeNG or None

value = None

What produces the values.

Type

NodeNG or None

class astroid.nodes.DictUnpack(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.NoChildrenMixin, astroid.nodes.node_ng.NodeNG

Represents the unpacking of dicts into dicts using PEP 448.

Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

class astroid.nodes.Ellipsis(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.NoChildrenMixin, astroid.nodes.node_ng.NodeNG

Class representing an ast.Ellipsis node.

An Ellipsis is the ... syntax.

Deprecated since v2.6.0 - Use Const instead. Will be removed with the release v2.7.0

Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

class astroid.nodes.EmptyNode(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.NoChildrenMixin, astroid.nodes.node_ng.NodeNG

Holds an arbitrary object in the LocalsDictNodeNG.locals.

Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

has_underlying_object()
object = None
class astroid.nodes.ExceptHandler(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.MultiLineBlockMixin, astroid.mixins.AssignTypeMixin, astroid.nodes.node_classes.Statement

Class representing an ast.ExceptHandler. node.

An ExceptHandler is an except block on a try-except.

>>> import astroid
>>> node = astroid.extract_node('''
    try:
        do_something()
    except Exception as error:
        print("Error!")
    ''')
>>> node
<TryExcept l.2 at 0x7f23b2e9d908>
>>> node.handlers
[<ExceptHandler l.4 at 0x7f23b2e9e860>]
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

assigned_stmts(node=None, context=None, assign_path=None)

Returns the assigned statement (non inferred) according to the assignment type. See astroid/protocols.py for actual implementation.

Parameters
Return type

Any

catch(exceptions)[source]

Check if this node handles any of the given

Parameters

exceptions (Optional[List[str]]) – The names of the exceptions to check for.

Return type

bool

get_children()[source]

Get the child nodes below this node.

postinit(type=None, name=None, body=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

:param body:The contents of the block.

blockstart_tolineno

<wrapped by the cachedproperty decorator> The line on which the beginning of this block ends.

type

int

body: List[NodeNG]

The contents of the block.

name: Optional[AssignName]

The name that the caught exception is assigned to.

type: Optional[NodeNG]

The types that the block handles.

Type

Tuple or NodeNG or None

class astroid.nodes.Expr(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_classes.Statement

Class representing an ast.Expr node.

An Expr is any expression that does not have its value used or stored.

>>> import astroid
>>> node = astroid.extract_node('method()')
>>> node
<Call l.1 at 0x7f23b2e352b0>
>>> node.parent
<Expr l.1 at 0x7f23b2e35278>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

postinit(value=None)[source]

Do some setup after initialisation.

Parameters

value (Optional[astroid.nodes.node_ng.NodeNG]) – What the expression does.

Return type

None

value: Optional[NodeNG]

What the expression does.

class astroid.nodes.ExtSlice(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_ng.NodeNG

Class representing an ast.ExtSlice node.

An ExtSlice is a complex slice expression.

Deprecated since v2.6.0 - Now part of the Subscript node. Will be removed with the release of v2.7.0

Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

class astroid.nodes.For(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.MultiLineBlockMixin, astroid.mixins.BlockRangeMixIn, astroid.mixins.AssignTypeMixin, astroid.nodes.node_classes.Statement

Class representing an ast.For node.

>>> import astroid
>>> node = astroid.extract_node('for thing in things: print(thing)')
>>> node
<For l.1 at 0x7f23b2e8cf28>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

assigned_stmts(node=None, context=None, assign_path=None)

Returns the assigned statement (non inferred) according to the assignment type. See astroid/protocols.py for actual implementation.

Parameters
Return type

Any

get_children()[source]

Get the child nodes below this node.

postinit(target=None, iter=None, body=None, orelse=None, type_annotation=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

blockstart_tolineno

<wrapped by the cachedproperty decorator> The line on which the beginning of this block ends.

type

int

body: List[NodeNG]

The contents of the body of the loop.

iter: Optional[NodeNG]

What the loop iterates over.

optional_assign: ClassVar[bool] = True

Whether this node optionally assigns a variable.

This is always True for For nodes.

orelse: List[NodeNG]

The contents of the else block of the loop.

target: Optional[NodeNG]

What the loop assigns to.

type_annotation: Optional[NodeNG]

If present, this will contain the type annotation passed by a type comment

class astroid.nodes.FormattedValue(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_ng.NodeNG

Class representing an ast.FormattedValue node.

Represents a PEP 498 format string.

>>> import astroid
>>> node = astroid.extract_node('f"Format {type_}"')
>>> node
<JoinedStr l.1 at 0x7f23b2e4ed30>
>>> node.values
[<Const.str l.1 at 0x7f23b2e4eda0>, <FormattedValue l.1 at 0x7f23b2e4edd8>]
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

postinit(value, conversion=None, format_spec=None)[source]

Do some setup after initialisation.

Parameters

  • value (astroid.nodes.node_ng.NodeNG) – The value to be formatted into the string.

  • conversion (Optional[int]) – The type of formatting to be applied to the value.

  • format_spec (JoinedStr or None) – The formatting to be applied to the value.

Return type

None

conversion: Optional[int]

The type of formatting to be applied to the value.

See also

ast.FormattedValue

format_spec: Optional[NodeNG]

The formatting to be applied to the value.

See also

ast.FormattedValue

Type

JoinedStr or None

value: NodeNG

The value to be formatted into the string.

class astroid.nodes.FunctionDef(name=None, doc=None, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.MultiLineBlockMixin, astroid.nodes.node_classes.Statement, astroid.nodes.scoped_nodes.scoped_nodes.Lambda

Class representing an ast.FunctionDef.

>>> import astroid
>>> node = astroid.extract_node('''
... def my_func(arg):
...     return arg + 1
... ''')
>>> node
<FunctionDef.my_func l.2 at 0x7f23b2e71e10>
Parameters

  • name (str or None) – The name of the function.

  • doc (Optional[str]) – The function docstring.

  • lineno (int or None) – The line that this node appears on in the source code.

  • col_offset (int or None) – The column that this node appears on in the source code.

  • parent (NodeNG or None) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

block_range(lineno)[source]

Get a range from the given line number to where this node ends.

Parameters

lineno (int) – Unused.

Returns

The range of line numbers that this node belongs to,

Return type

tuple(int, int)

bool_value(context=None)[source]

Determine the boolean value of this node.

Returns

The boolean value of this node. For a FunctionDef this is always True.

Return type

bool

decoratornames(context=None)[source]

Get the qualified names of each of the decorators on this function.

Parameters

context – An inference context that can be passed to inference functions

Returns

The names of the decorators.

Return type

set(str)

frame(*, future=None)[source]

The node’s frame node.

A frame node is a Module, FunctionDef, ClassDef or Lambda.

Returns

The node itself.

Parameters

  • self (astroid.nodes.scoped_nodes.scoped_nodes.T) –

  • future (Optional[typing_extensions.Literal[None, True]]) –

Return type

astroid.nodes.scoped_nodes.scoped_nodes.T

get_children()[source]

Get the child nodes below this node.

igetattr(name, context=None)[source]

Inferred getattr, which returns an iterator of inferred statements.

implicit_parameters()[source]
Return type

typing_extensions.Literal[0, 1]

infer_call_result(caller=None, context=None)[source]

Infer what the function returns when called.

Returns

What the function returns.

Return type

iterable(NodeNG or Uninferable) or None

infer_yield_result(context=None)[source]

Infer what the function yields when called

Returns

What the function yields

Return type

iterable(NodeNG or Uninferable) or None

is_abstract(pass_is_abstract=True, any_raise_is_abstract=False)[source]

Check if the method is abstract.

A method is considered abstract if any of the following is true: * The only statement is ‘raise NotImplementedError’ * The only statement is ‘raise <SomeException>’ and any_raise_is_abstract is True * The only statement is ‘pass’ and pass_is_abstract is True * The method is annotated with abc.astractproperty/abc.abstractmethod

Returns

True if the method is abstract, False otherwise.

Return type

bool

is_bound()[source]

Check if the function is bound to an instance or class.

Returns

True if the function is bound to an instance or class, False otherwise.

Return type

bool

is_generator()[source]

Check if this is a generator function.

Returns

True is this is a generator function, False otherwise.

Return type

bool

is_method()[source]

Check if this function node represents a method.

Returns

True if this is a method, False otherwise.

Return type

bool

postinit(args, body, decorators=None, returns=None, type_comment_returns=None, type_comment_args=None, *, position=None, doc_node=None)[source]

Do some setup after initialisation.

Parameters
Params type_comment_returns

The return type annotation passed via a type comment.

Params type_comment_args

The args type annotation passed via a type comment.

Params position

Position of function keyword(s) and name.

scope_lookup(node, name, offset=0)[source]

Lookup where the given name is assigned.

blockstart_tolineno

<wrapped by the cachedproperty decorator> The line on which the beginning of this block ends.

type

int

decorators: Optional[astroid.nodes.node_classes.Decorators] = None

The decorators that are applied to this method or function.

property doc: Optional[str]

The function docstring.

doc_node: Optional[Const]

The doc node associated with this node.

extra_decorators

<wrapped by the cachedproperty decorator> The extra decorators that this function can have.

Additional decorators are considered when they are used as assignments, as in method = staticmethod(method). The property will return all the callables that are used for decoration.

fromlineno

<wrapped by the cachedproperty decorator> The first line that this node appears on in the source code.

is_function: ClassVar[bool] = True

Whether this node indicates a function.

For a FunctionDef this is always True.

Type

bool

returns = None
type

<wrapped by the cachedproperty decorator> The function type for this node.

Possible values are: method, function, staticmethod, classmethod.

type

str

type_annotation = None

If present, this will contain the type annotation passed by a type comment

Type

NodeNG or None

type_comment_args = None

If present, this will contain the type annotation for arguments passed by a type comment

type_comment_returns = None

If present, this will contain the return type annotation, passed by a type comment

class astroid.nodes.GeneratorExp(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.scoped_nodes.mixin.ComprehensionScope

Class representing an ast.GeneratorExp node.

>>> import astroid
>>> node = astroid.extract_node('(thing for thing in things if thing)')
>>> node
<GeneratorExp l.1 at 0x7f23b2e4e400>
Parameters

  • lineno (int or None) – The line that this node appears on in the source code.

  • col_offset (int or None) – The column that this node appears on in the source code.

  • parent (NodeNG or None) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

bool_value(context=None)[source]

Determine the boolean value of this node.

Returns

The boolean value of this node. For a GeneratorExp this is always True.

Return type

bool

get_children()[source]

Get the child nodes below this node.

postinit(elt=None, generators=None)[source]

Do some setup after initialisation.

Parameters

  • elt (NodeNG or None) – The element that forms the output of the expression.

  • generators (list(Comprehension) or None) – The generators that are looped through.

elt = None

The element that forms the output of the expression.

Type

NodeNG or None

generators = None

The generators that are looped through.

Type

list(Comprehension) or None

class astroid.nodes.Global(names, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.NoChildrenMixin, astroid.nodes.node_classes.Statement

Class representing an ast.Global node.

>>> import astroid
>>> node = astroid.extract_node('global a_global')
>>> node
<Global l.1 at 0x7f23b2e9de10>
Parameters

  • names (List[str]) – The names being declared as global.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

names: List[str]

The names being declared as global.

class astroid.nodes.If(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.MultiLineBlockMixin, astroid.mixins.BlockRangeMixIn, astroid.nodes.node_classes.Statement

Class representing an ast.If node.

>>> import astroid
>>> node = astroid.extract_node('if condition: print(True)')
>>> node
<If l.1 at 0x7f23b2e9dd30>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

block_range(lineno)[source]

Get a range from the given line number to where this node ends.

Parameters

lineno (int) – The line number to start the range at.

Returns

The range of line numbers that this node belongs to, starting at the given line number.

Return type

tuple(int, int)

get_children()[source]

Get the child nodes below this node.

has_elif_block()[source]
is_sys_guard()[source]

Return True if IF stmt is a sys.version_info guard.

>>> import astroid
>>> node = astroid.extract_node('''
import sys
if sys.version_info > (3, 8):
    from typing import Literal
else:
    from typing_extensions import Literal
''')
>>> node.is_sys_guard()
True
Return type

bool

is_typing_guard()[source]

Return True if IF stmt is a typing guard.

>>> import astroid
>>> node = astroid.extract_node('''
from typing import TYPE_CHECKING
if TYPE_CHECKING:
    from xyz import a
''')
>>> node.is_typing_guard()
True
Return type

bool

postinit(test=None, body=None, orelse=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

blockstart_tolineno

<wrapped by the cachedproperty decorator> The line on which the beginning of this block ends.

type

int

body: List[NodeNG]

The contents of the block.

is_orelse: bool

Whether the if-statement is the orelse-block of another if statement.

orelse: List[NodeNG]

The contents of the else block.

test: Optional[NodeNG]

The condition that the statement tests.

class astroid.nodes.IfExp(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_ng.NodeNG

Class representing an ast.IfExp node. >>> import astroid >>> node = astroid.extract_node(‘value if condition else other’) >>> node <IfExp l.1 at 0x7f23b2e9dbe0>

Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

op_left_associative()[source]
postinit(test=None, body=None, orelse=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

body: Optional[NodeNG]

The contents of the block.

orelse: Optional[NodeNG]

The contents of the else block.

test: Optional[NodeNG]

The condition that the statement tests.

class astroid.nodes.Import(names=None, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.NoChildrenMixin, astroid.mixins.ImportFromMixin, astroid.nodes.node_classes.Statement

Class representing an ast.Import node. >>> import astroid >>> node = astroid.extract_node(‘import astroid’) >>> node <Import l.1 at 0x7f23b2e4e5c0>

Parameters

  • names (Optional[List[Tuple[str, Optional[str]]]]) – The names being imported.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

names: List[Tuple[str, Optional[str]]]

The names being imported.

Each entry is a tuple of the name being imported, and the alias that the name is assigned to (if any).

class astroid.nodes.ImportFrom(fromname, names, level=0, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.NoChildrenMixin, astroid.mixins.ImportFromMixin, astroid.nodes.node_classes.Statement

Class representing an ast.ImportFrom node.

>>> import astroid
>>> node = astroid.extract_node('from my_package import my_module')
>>> node
<ImportFrom l.1 at 0x7f23b2e415c0>
Parameters

  • fromname (Optional[str]) – The module that is being imported from.

  • names (List[Tuple[str, Optional[str]]]) – What is being imported from the module.

  • level (Optional[int]) – The level of relative import.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

level: Optional[int]

The level of relative import.

Essentially this is the number of dots in the import. This is always 0 for absolute imports.

modname: Optional[str]

The module that is being imported from.

This is None for relative imports.

names: List[Tuple[str, Optional[str]]]

What is being imported from the module.

Each entry is a tuple of the name being imported, and the alias that the name is assigned to (if any).

class astroid.nodes.Index(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_ng.NodeNG

Class representing an ast.Index node.

An Index is a simple subscript.

Deprecated since v2.6.0 - Now part of the Subscript node. Will be removed with the release of v2.7.0

Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

class astroid.nodes.JoinedStr(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_ng.NodeNG

Represents a list of string expressions to be joined.

>>> import astroid
>>> node = astroid.extract_node('f"Format {type_}"')
>>> node
<JoinedStr l.1 at 0x7f23b2e4ed30>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

postinit(values=None)[source]

Do some setup after initialisation.

Parameters
Type

list(FormattedValue or Const)

Return type

None

values: List[NodeNG]

The string expressions to be joined.

Type

list(FormattedValue or Const)

class astroid.nodes.Keyword(arg=None, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_ng.NodeNG

Class representing an ast.keyword node.

>>> import astroid
>>> node = astroid.extract_node('function(a_kwarg=True)')
>>> node
<Call l.1 at 0x7f23b2e9e320>
>>> node.keywords
[<Keyword l.1 at 0x7f23b2e9e9b0>]
Parameters

  • arg (Optional[str]) – The argument being assigned to.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

postinit(value=None)[source]

Do some setup after initialisation.

Parameters

value (Optional[astroid.nodes.node_ng.NodeNG]) – The value being assigned to the keyword argument.

Return type

None

arg: Optional[str]

The argument being assigned to.

value: Optional[NodeNG]

The value being assigned to the keyword argument.

class astroid.nodes.Lambda(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.FilterStmtsMixin, astroid.nodes.scoped_nodes.mixin.LocalsDictNodeNG

Class representing an ast.Lambda node.

>>> import astroid
>>> node = astroid.extract_node('lambda arg: arg + 1')
>>> node
<Lambda.<lambda> l.1 at 0x7f23b2e41518>
Parameters

  • lineno (int or None) – The line that this node appears on in the source code.

  • col_offset (int or None) – The column that this node appears on in the source code.

  • parent (NodeNG or None) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

argnames()[source]

Get the names of each of the arguments, including that of the collections of variable-length arguments (“args”, “kwargs”, etc.), as well as positional-only and keyword-only arguments.

Returns

The names of the arguments.

Return type

list(str)

bool_value(context=None)[source]

Determine the boolean value of this node.

Returns

The boolean value of this node. For a Lambda this is always True.

Return type

bool

callable()[source]

Whether this node defines something that is callable.

Returns

True if this defines something that is callable, False otherwise. For a Lambda this is always True.

Return type

bool

display_type()[source]

A human readable type of this node.

Returns

The type of this node.

Return type

str

frame(*, future=None)[source]

The node’s frame node.

A frame node is a Module, FunctionDef, ClassDef or Lambda.

Returns

The node itself.

Parameters

  • self (astroid.nodes.scoped_nodes.scoped_nodes.T) –

  • future (Optional[typing_extensions.Literal[None, True]]) –

Return type

astroid.nodes.scoped_nodes.scoped_nodes.T

get_children()[source]

Get the child nodes below this node.

getattr(name, context=None)[source]
Parameters

  • name (str) –

  • context (Optional[astroid.context.InferenceContext]) –

Return type

List[astroid.nodes.node_ng.NodeNG]

implicit_parameters()[source]
infer_call_result(caller, context=None)[source]

Infer what the function returns when called.

Parameters

caller (object) – Unused

postinit(args, body)[source]

Do some setup after initialisation.

Parameters
pytype()[source]

Get the name of the type that this node represents.

Returns

The name of the type.

Return type

str

scope_lookup(node, name, offset=0)[source]

Lookup where the given names is assigned.

Parameters

  • node (NodeNG) – The node to look for assignments up to. Any assignments after the given node are ignored.

  • name (str) – The name to find assignments for.

  • offset (int) – The line offset to filter statements up to.

Returns

This scope node and the list of assignments associated to the given name according to the scope where it has been found (locals, globals or builtin).

Return type

tuple(str, list(NodeNG))

args: Arguments

The arguments that the function takes.

body

The contents of the function body.

Type

list(NodeNG)

is_lambda: ClassVar[bool] = True
name = '<lambda>'
special_attributes

The names of special attributes that this function has.

property type

Whether this is a method or function.

Returns

‘method’ if this is a method, ‘function’ otherwise.

Return type

str

class astroid.nodes.List(ctx=None, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_classes.BaseContainer

Class representing an ast.List node.

>>> import astroid
>>> node = astroid.extract_node('[1, 2, 3]')
>>> node
<List.list l.1 at 0x7f23b2e9e128>
Parameters

  • ctx (Optional[astroid.const.Context]) – Whether the list is assigned to or loaded from.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

assigned_stmts(node=None, context=None, assign_path=None)

Returns the assigned statement (non inferred) according to the assignment type. See astroid/protocols.py for actual implementation.

Parameters
Return type

Any

getitem(index, context=None)[source]

Get an item from this node.

Parameters

index (Const or Slice) – The node to use as a subscript index.

infer_binary_op(opnode, operator, other, context, method)

Infer a binary operation on a tuple or list.

The instance on which the binary operation is performed is a tuple or list. This refers to the left-hand side of the operation, so: ‘tuple() + 1’ or ‘[] + A()’

Parameters
Return type

Generator[astroid.nodes.node_ng.NodeNG, None, None]

infer_unary_op(op)
pytype()[source]

Get the name of the type that this node represents.

Returns

The name of the type.

Return type

str

ctx: Optional[Context]

Whether the list is assigned to or loaded from.

class astroid.nodes.ListComp(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.scoped_nodes.mixin.ComprehensionScope

Class representing an ast.ListComp node.

>>> import astroid
>>> node = astroid.extract_node('[thing for thing in things if thing]')
>>> node
<ListComp l.1 at 0x7f23b2e418d0>
Parameters

  • lineno – The line that this node appears on in the source code.

  • col_offset – The column that this node appears on in the source code.

  • parent – The parent node in the syntax tree.

  • end_lineno – The last line this node appears on in the source code.

  • end_col_offset – The end column this node appears on in the source code. Note: This is after the last symbol.

bool_value(context=None)[source]

Determine the boolean value of this node.

Returns

The boolean value of this node. For a ListComp this is always Uninferable.

Return type

Uninferable

get_children()[source]

Get the child nodes below this node.

postinit(elt=None, generators=None)[source]

Do some setup after initialisation.

Parameters

  • elt (NodeNG or None) – The element that forms the output of the expression.

  • generators (list(Comprehension) or None) – The generators that are looped through.

elt = None

The element that forms the output of the expression.

Type

NodeNG or None

generators = None

The generators that are looped through.

Type

list(Comprehension) or None

class astroid.nodes.Match(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_classes.Statement

Class representing a ast.Match node.

>>> import astroid
>>> node = astroid.extract_node('''
match x:
    case 200:
        ...
    case _:
        ...
''')
>>> node
<Match l.2 at 0x10c24e170>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

postinit(*, subject, cases)[source]
Parameters
Return type

None

class astroid.nodes.MatchAs(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.AssignTypeMixin, astroid.nodes.node_classes.Pattern

Class representing a ast.MatchAs node.

>>> import astroid
>>> node = astroid.extract_node('''
match x:
    case [1, a]:
        ...
    case {'key': b}:
        ...
    case Point2D(0, 0) as c:
        ...
    case d:
        ...
''')
>>> node.cases[0].pattern.patterns[1]
<MatchAs l.3 at 0x10d0b2da0>
>>> node.cases[1].pattern.patterns[0]
<MatchAs l.5 at 0x10d0b2920>
>>> node.cases[2].pattern
<MatchAs l.7 at 0x10d0b06a0>
>>> node.cases[3].pattern
<MatchAs l.9 at 0x10d09b880>
Parameters

  • lineno (Optional[int]) –

  • col_offset (Optional[int]) –

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) –

  • end_lineno (Optional[int]) –

  • end_col_offset (Optional[int]) –

Return type

None

assigned_stmts(node, context=None, assign_path=None)

Returns the assigned statement (non inferred) according to the assignment type. See astroid/protocols.py for actual implementation.

Parameters
Return type

Generator[astroid.nodes.node_ng.NodeNG, None, None]

postinit(*, pattern, name)[source]
Parameters
Return type

None

class astroid.nodes.MatchCase(*, parent=None)[source]

Bases: astroid.mixins.MultiLineBlockMixin, astroid.nodes.node_ng.NodeNG

Class representing a ast.match_case node.

>>> import astroid
>>> node = astroid.extract_node('''
match x:
    case 200:
        ...
''')
>>> node.cases[0]
<MatchCase l.3 at 0x10c24e590>
Parameters

parent (Optional[astroid.nodes.node_ng.NodeNG]) –

Return type

None

postinit(*, pattern, guard, body)[source]
Parameters
Return type

None

col_offset: None

The column that this node appears on in the source code.

end_col_offset: None

The end column this node appears on in the source code. Note: This is after the last symbol.

end_lineno: None

The last line this node appears on in the source code.

lineno: None

The line that this node appears on in the source code.

class astroid.nodes.MatchClass(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_classes.Pattern

Class representing a ast.MatchClass node.

>>> import astroid
>>> node = astroid.extract_node('''
match x:
    case Point2D(0, 0):
        ...
    case Point3D(x=0, y=0, z=0):
        ...
''')
>>> node.cases[0].pattern
<MatchClass l.3 at 0x10ca83940>
>>> node.cases[1].pattern
<MatchClass l.5 at 0x10ca80880>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

postinit(*, cls, patterns, kwd_attrs, kwd_patterns)[source]
Parameters
Return type

None

class astroid.nodes.MatchMapping(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.AssignTypeMixin, astroid.nodes.node_classes.Pattern

Class representing a ast.MatchMapping node.

>>> import astroid
>>> node = astroid.extract_node('''
match x:
    case {1: "Hello", 2: "World", 3: _, **rest}:
        ...
''')
>>> node.cases[0].pattern
<MatchMapping l.3 at 0x10c8a8850>
Parameters

  • lineno (Optional[int]) –

  • col_offset (Optional[int]) –

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) –

  • end_lineno (Optional[int]) –

  • end_col_offset (Optional[int]) –

Return type

None

assigned_stmts(node, context=None, assign_path=None)

Returns the assigned statement (non inferred) according to the assignment type. See astroid/protocols.py for actual implementation.

Parameters
Return type

Generator[astroid.nodes.node_ng.NodeNG, None, None]

postinit(*, keys, patterns, rest)[source]
Parameters
Return type

None

class astroid.nodes.MatchOr(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_classes.Pattern

Class representing a ast.MatchOr node.

>>> import astroid
>>> node = astroid.extract_node('''
match x:
    case 400 | 401 | 402:
        ...
''')
>>> node.cases[0].pattern
<MatchOr l.3 at 0x10d0b0b50>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

postinit(*, patterns)[source]
Parameters

patterns (List[astroid.nodes.node_classes.Pattern]) –

Return type

None

class astroid.nodes.MatchSequence(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_classes.Pattern

Class representing a ast.MatchSequence node.

>>> import astroid
>>> node = astroid.extract_node('''
match x:
    case [1, 2]:
        ...
    case (1, 2, *_):
        ...
''')
>>> node.cases[0].pattern
<MatchSequence l.3 at 0x10ca80d00>
>>> node.cases[1].pattern
<MatchSequence l.5 at 0x10ca80b20>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

postinit(*, patterns)[source]
Parameters

patterns (List[astroid.nodes.node_classes.Pattern]) –

Return type

None

class astroid.nodes.MatchSingleton(*, value, lineno=None, col_offset=None, end_lineno=None, end_col_offset=None, parent=None)[source]

Bases: astroid.nodes.node_classes.Pattern

Class representing a ast.MatchSingleton node.

>>> import astroid
>>> node = astroid.extract_node('''
match x:
    case True:
        ...
    case False:
        ...
    case None:
        ...
''')
>>> node.cases[0].pattern
<MatchSingleton l.3 at 0x10c2282e0>
>>> node.cases[1].pattern
<MatchSingleton l.5 at 0x10c228af0>
>>> node.cases[2].pattern
<MatchSingleton l.7 at 0x10c229f90>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

  • value (typing_extensions.Literal[True, False, None]) –

Return type

None

class astroid.nodes.MatchStar(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.AssignTypeMixin, astroid.nodes.node_classes.Pattern

Class representing a ast.MatchStar node.

>>> import astroid
>>> node = astroid.extract_node('''
match x:
    case [1, *_]:
        ...
''')
>>> node.cases[0].pattern.patterns[1]
<MatchStar l.3 at 0x10ca809a0>
Parameters

  • lineno (Optional[int]) –

  • col_offset (Optional[int]) –

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) –

  • end_lineno (Optional[int]) –

  • end_col_offset (Optional[int]) –

Return type

None

assigned_stmts(node, context=None, assign_path=None)

Returns the assigned statement (non inferred) according to the assignment type. See astroid/protocols.py for actual implementation.

Parameters
Return type

Generator[astroid.nodes.node_ng.NodeNG, None, None]

postinit(*, name)[source]
Parameters

name (Optional[astroid.nodes.node_classes.AssignName]) –

Return type

None

class astroid.nodes.MatchValue(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_classes.Pattern

Class representing a ast.MatchValue node.

>>> import astroid
>>> node = astroid.extract_node('''
match x:
    case 200:
        ...
''')
>>> node.cases[0].pattern
<MatchValue l.3 at 0x10c24e200>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

postinit(*, value)[source]
Parameters

value (astroid.nodes.node_ng.NodeNG) –

Return type

None

class astroid.nodes.Module(name, doc=None, file=None, path=None, package=None, parent=None, pure_python=True)[source]

Bases: astroid.nodes.scoped_nodes.mixin.LocalsDictNodeNG

Class representing an ast.Module node.

>>> import astroid
>>> node = astroid.extract_node('import astroid')
>>> node
<Import l.1 at 0x7f23b2e4e5c0>
>>> node.parent
<Module l.0 at 0x7f23b2e4eda0>
Parameters

  • name (str) – The name of the module.

  • doc (Optional[str]) – The module docstring.

  • file (Optional[str]) – The path to the file that this ast has been extracted from.

  • path (Optional[List[str]]) –

  • package (Optional[bool]) – Whether the node represents a package or a module.

  • parent (None) – The parent node in the syntax tree.

  • pure_python (Optional[bool]) – Whether the ast was built from source.

Return type

None

absolute_import_activated()[source]

Whether PEP 328 absolute import behaviour has been enabled.

Returns

True if PEP 328 has been enabled, False otherwise.

Return type

bool

block_range(lineno)[source]

Get a range from where this node starts to where this node ends.

Parameters

lineno (int) – Unused.

Returns

The range of line numbers that this node belongs to.

Return type

tuple(int, int)

bool_value(context=None)[source]

Determine the boolean value of this node.

Returns

The boolean value of this node. For a Module this is always True.

Return type

bool

display_type()[source]

A human readable type of this node.

Returns

The type of this node.

Return type

str

frame(*, future=None)[source]

The node’s frame node.

A frame node is a Module, FunctionDef, ClassDef or Lambda.

Returns

The node itself.

Parameters

  • self (astroid.nodes.scoped_nodes.scoped_nodes.T) –

  • future (Optional[typing_extensions.Literal[None, True]]) –

Return type

astroid.nodes.scoped_nodes.scoped_nodes.T

fully_defined()[source]

Check if this module has been build from a .py file.

If so, the module contains a complete representation, including the code.

Returns

True if the module has been built from a .py file.

Return type

bool

get_children()[source]

Get the child nodes below this node.

getattr(name, context=None, ignore_locals=False)[source]
igetattr(name, context=None)[source]

Infer the possible values of the given variable.

Parameters

name (str) – The name of the variable to infer.

Returns

The inferred possible values.

Return type

iterable(NodeNG) or None

import_module(modname, relative_only=False, level=None)[source]

Get the ast for a given module as if imported from this module.

Parameters

  • modname (str) – The name of the module to “import”.

  • relative_only (bool) – Whether to only consider relative imports.

  • level (int or None) – The level of relative import.

Returns

The imported module ast.

Return type

NodeNG

next_sibling()[source]

The next sibling statement node.

Returns

The next sibling statement node.

Return type

NodeNG or None

postinit(body=None, *, doc_node=None)[source]

Do some setup after initialisation.

Parameters
previous_sibling()[source]

The previous sibling statement.

Returns

The previous sibling statement node.

Return type

NodeNG or None

public_names()[source]

The list of the names that are publicly available in this module.

Returns

The list of public names.

Return type

list(str)

pytype()[source]

Get the name of the type that this node represents.

Returns

The name of the type.

Return type

str

relative_to_absolute_name(modname, level)[source]

Get the absolute module name for a relative import.

The relative import can be implicit or explicit.

Parameters

  • modname (str) – The module name to convert.

  • level (int) – The level of relative import.

Returns

The absolute module name.

Raises

TooManyLevelsError – When the relative import refers to a module too far above this one.

Return type

str

scope_lookup(node, name, offset=0)[source]

Lookup where the given variable is assigned.

Parameters

  • node (NodeNG) – The node to look for assignments up to. Any assignments after the given node are ignored.

  • name (str) – The name of the variable to find assignments for.

  • offset (int) – The line offset to filter statements up to.

Returns

This scope node and the list of assignments associated to the given name according to the scope where it has been found (locals, globals or builtin).

Return type

tuple(str, list(NodeNG))

statement(*, future: None = None) → Module[source]
statement(*, future: typing_extensions.Literal[True]) → NoReturn

The first parent node, including self, marked as statement node.

When called on a Module with the future parameter this raises an error.

TODO: Deprecate the future parameter and only raise StatementMissing

Raises

StatementMissing – If no self has no parent attribute and future is True

stream()[source]

Get a stream to the underlying file or bytes.

Type

file or io.BytesIO or None

wildcard_import_names()[source]

The list of imported names when this module is ‘wildcard imported’.

It doesn’t include the ‘__builtins__’ name which is added by the current CPython implementation of wildcard imports.

Returns

The list of imported names.

Return type

list(str)

body: Optional[List[node_classes.NodeNG]]

The contents of the module.

col_offset: None

The column that this node appears on in the source code.

property doc: Optional[str]

The module docstring.

doc_node: Optional[Const]

The doc node associated with this node.

end_col_offset: None

The end column this node appears on in the source code. Note: This is after the last symbol.

end_lineno: None

The last line this node appears on in the source code.

file

The path to the file that this ast has been extracted from.

This will be None when the representation has been built from a built-in module.

file_bytes: Optional[Union[str, bytes]] = None

The string/bytes that this ast was built from.

file_encoding: Optional[str] = None

The encoding of the source file.

This is used to get unicode out of a source file. Python 2 only.

fromlineno: typing_extensions.Literal[0] = 0

The first line that this node appears on in the source code.

future_imports: Set[str]

The imports from __future__.

globals: Dict[str, List[node_classes.NodeNG]]

A map of the name of a global variable to the node defining the global.

lineno: typing_extensions.Literal[0] = 0

The line that this node appears on in the source code.

name

The name of the module.

package

Whether the node represents a package or a module.

parent: None

The parent node in the syntax tree.

pure_python

Whether the ast was built from source.

scope_attrs = {'__doc__', '__file__', '__name__', '__package__', '__path__'}

The names of module attributes available through the global scope.

special_attributes

The names of special attributes that this module has.

class astroid.nodes.Name(name=None, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.NoChildrenMixin, astroid.nodes.node_classes.LookupMixIn, astroid.nodes.node_ng.NodeNG

Class representing an ast.Name node.

A Name node is something that is named, but not covered by AssignName or DelName.

>>> import astroid
>>> node = astroid.extract_node('range(10)')
>>> node
<Call l.1 at 0x7effe1db8710>
>>> list(node.get_children())
[<Name.range l.1 at 0x7effe1db86a0>, <Const.int l.1 at 0x7effe1db8518>]
>>> list(node.get_children())[0].as_string()
'range'
Parameters

  • name (Optional[str]) – The name that this node refers to.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

name: Optional[str]

The name that this node refers to.

class astroid.nodes.Nonlocal(names, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.NoChildrenMixin, astroid.nodes.node_classes.Statement

Class representing an ast.Nonlocal node.

>>> import astroid
>>> node = astroid.extract_node('''
def function():
    nonlocal var
''')
>>> node
<FunctionDef.function l.2 at 0x7f23b2e9e208>
>>> node.body[0]
<Nonlocal l.3 at 0x7f23b2e9e908>
Parameters

  • names (List[str]) – The names being declared as not local.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

names: List[str]

The names being declared as not local.

class astroid.nodes.Pass(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.NoChildrenMixin, astroid.nodes.node_classes.Statement

Class representing an ast.Pass node.

>>> import astroid
>>> node = astroid.extract_node('pass')
>>> node
<Pass l.1 at 0x7f23b2e9e748>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

class astroid.nodes.Raise(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_classes.Statement

Class representing an ast.Raise node.

>>> import astroid
>>> node = astroid.extract_node('raise RuntimeError("Something bad happened!")')
>>> node
<Raise l.1 at 0x7f23b2e9e828>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

postinit(exc=None, cause=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

raises_not_implemented()[source]

Check if this node raises a NotImplementedError.

Returns

True if this node raises a NotImplementedError, False otherwise.

Return type

bool

cause: Optional[NodeNG]

The exception being used to raise this one.

exc: Optional[NodeNG]

What is being raised.

class astroid.nodes.Return(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_classes.Statement

Class representing an ast.Return node.

>>> import astroid
>>> node = astroid.extract_node('return True')
>>> node
<Return l.1 at 0x7f23b8211908>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

is_tuple_return()[source]
postinit(value=None)[source]

Do some setup after initialisation.

Parameters

value (Optional[astroid.nodes.node_ng.NodeNG]) – The value being returned.

Return type

None

value: Optional[NodeNG]

The value being returned.

class astroid.nodes.Set(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_classes.BaseContainer

Class representing an ast.Set node.

>>> import astroid
>>> node = astroid.extract_node('{1, 2, 3}')
>>> node
<Set.set l.1 at 0x7f23b2e71d68>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

infer_unary_op(op)
pytype()[source]

Get the name of the type that this node represents.

Returns

The name of the type.

Return type

str

class astroid.nodes.SetComp(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.scoped_nodes.mixin.ComprehensionScope

Class representing an ast.SetComp node.

>>> import astroid
>>> node = astroid.extract_node('{thing for thing in things if thing}')
>>> node
<SetComp l.1 at 0x7f23b2e41898>
Parameters

  • lineno (int or None) – The line that this node appears on in the source code.

  • col_offset (int or None) – The column that this node appears on in the source code.

  • parent (NodeNG or None) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

bool_value(context=None)[source]

Determine the boolean value of this node.

Returns

The boolean value of this node. For a SetComp this is always Uninferable.

Return type

Uninferable

get_children()[source]

Get the child nodes below this node.

postinit(elt=None, generators=None)[source]

Do some setup after initialisation.

Parameters

  • elt (NodeNG or None) – The element that forms the output of the expression.

  • generators (list(Comprehension) or None) – The generators that are looped through.

elt = None

The element that forms the output of the expression.

Type

NodeNG or None

generators = None

The generators that are looped through.

Type

list(Comprehension) or None

class astroid.nodes.Slice(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_ng.NodeNG

Class representing an ast.Slice node.

>>> import astroid
>>> node = astroid.extract_node('things[1:3]')
>>> node
<Subscript l.1 at 0x7f23b2e71f60>
>>> node.slice
<Slice l.1 at 0x7f23b2e71e80>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

getattr(attrname, context=None)[source]
igetattr(attrname, context=None)[source]

Infer the possible values of the given attribute on the slice.

Parameters

attrname (str) – The name of the attribute to infer.

Returns

The inferred possible values.

Return type

iterable(NodeNG)

postinit(lower=None, upper=None, step=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

pytype()[source]

Get the name of the type that this node represents.

Returns

The name of the type.

Return type

str

lower: Optional[NodeNG]

The lower index in the slice.

step: Optional[NodeNG]

The step to take between indexes.

upper: Optional[NodeNG]

The upper index in the slice.

class astroid.nodes.Starred(ctx=None, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.ParentAssignTypeMixin, astroid.nodes.node_ng.NodeNG

Class representing an ast.Starred node.

>>> import astroid
>>> node = astroid.extract_node('*args')
>>> node
<Starred l.1 at 0x7f23b2e41978>
Parameters

  • ctx (Optional[astroid.const.Context]) – Whether the list is assigned to or loaded from.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

assigned_stmts(node=None, context=None, assign_path=None)

Returns the assigned statement (non inferred) according to the assignment type. See astroid/protocols.py for actual implementation.

Parameters
Return type

Any

get_children()[source]

Get the child nodes below this node.

postinit(value=None)[source]

Do some setup after initialisation.

Parameters

value (Optional[astroid.nodes.node_ng.NodeNG]) – What is being unpacked.

Return type

None

ctx: Optional[Context]

Whether the starred item is assigned to or loaded from.

value: Optional[NodeNG]

What is being unpacked.

class astroid.nodes.Subscript(ctx=None, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_ng.NodeNG

Class representing an ast.Subscript node.

>>> import astroid
>>> node = astroid.extract_node('things[1:3]')
>>> node
<Subscript l.1 at 0x7f23b2e71f60>
Parameters

  • ctx (Optional[astroid.const.Context]) – Whether the subscripted item is assigned to or loaded from.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

infer_lhs(context=None)

Inference for subscripts

We’re understanding if the index is a Const or a slice, passing the result of inference to the value’s getitem method, which should handle each supported index type accordingly.

postinit(value=None, slice=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

ctx: Optional[Context]

Whether the subscripted item is assigned to or loaded from.

slice: Optional[NodeNG]

The slice being used to lookup.

value: Optional[NodeNG]

What is being indexed.

class astroid.nodes.TryExcept(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.MultiLineBlockMixin, astroid.mixins.BlockRangeMixIn, astroid.nodes.node_classes.Statement

Class representing an ast.TryExcept node.

>>> import astroid
>>> node = astroid.extract_node('''
    try:
        do_something()
    except Exception as error:
        print("Error!")
    ''')
>>> node
<TryExcept l.2 at 0x7f23b2e9d908>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

block_range(lineno)[source]

Get a range from the given line number to where this node ends.

Parameters

lineno (int) – The line number to start the range at.

Returns

The range of line numbers that this node belongs to, starting at the given line number.

Return type

tuple(int, int)

get_children()[source]

Get the child nodes below this node.

postinit(body=None, handlers=None, orelse=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

body: List[NodeNG]

The contents of the block to catch exceptions from.

handlers: List[ExceptHandler]

The exception handlers.

orelse: List[NodeNG]

The contents of the else block.

class astroid.nodes.TryFinally(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.MultiLineBlockMixin, astroid.mixins.BlockRangeMixIn, astroid.nodes.node_classes.Statement

Class representing an ast.TryFinally node.

>>> import astroid
>>> node = astroid.extract_node('''
try:
    do_something()
except Exception as error:
    print("Error!")
finally:
    print("Cleanup!")
''')
>>> node
<TryFinally l.2 at 0x7f23b2e41d68>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

block_range(lineno)[source]

Get a range from the given line number to where this node ends.

Parameters

lineno (int) – The line number to start the range at.

Returns

The range of line numbers that this node belongs to, starting at the given line number.

Return type

tuple(int, int)

get_children()[source]

Get the child nodes below this node.

postinit(body=None, finalbody=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

body: List[Union[NodeNG, TryExcept]]

The try-except that the finally is attached to.

finalbody: List[NodeNG]

The contents of the finally block.

class astroid.nodes.Tuple(ctx=None, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_classes.BaseContainer

Class representing an ast.Tuple node.

>>> import astroid
>>> node = astroid.extract_node('(1, 2, 3)')
>>> node
<Tuple.tuple l.1 at 0x7f23b2e41780>
Parameters

  • ctx (Optional[astroid.const.Context]) – Whether the tuple is assigned to or loaded from.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

assigned_stmts(node=None, context=None, assign_path=None)

Returns the assigned statement (non inferred) according to the assignment type. See astroid/protocols.py for actual implementation.

Parameters
Return type

Any

getitem(index, context=None)[source]

Get an item from this node.

Parameters

index (Const or Slice) – The node to use as a subscript index.

infer_binary_op(opnode, operator, other, context, method)

Infer a binary operation on a tuple or list.

The instance on which the binary operation is performed is a tuple or list. This refers to the left-hand side of the operation, so: ‘tuple() + 1’ or ‘[] + A()’

Parameters
Return type

Generator[astroid.nodes.node_ng.NodeNG, None, None]

infer_unary_op(op)
pytype()[source]

Get the name of the type that this node represents.

Returns

The name of the type.

Return type

str

ctx: Optional[Context]

Whether the tuple is assigned to or loaded from.

class astroid.nodes.UnaryOp(op=None, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_ng.NodeNG

Class representing an ast.UnaryOp node.

>>> import astroid
>>> node = astroid.extract_node('-5')
>>> node
<UnaryOp l.1 at 0x7f23b2e4e198>
Parameters

  • op (Optional[str]) – The operator.

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

op_precedence()[source]
postinit(operand=None)[source]

Do some setup after initialisation.

Parameters

operand (Optional[astroid.nodes.node_ng.NodeNG]) – What the unary operator is applied to.

Return type

None

type_errors(context=None)[source]

Get a list of type errors which can occur during inference.

Each TypeError is represented by a BadBinaryOperationMessage, which holds the original exception.

Returns

The list of possible type errors.

Return type

list(BadBinaryOperationMessage)

op: Optional[str]

The operator.

operand: Optional[NodeNG]

What the unary operator is applied to.

class astroid.nodes.Unknown(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.AssignTypeMixin, astroid.nodes.node_ng.NodeNG

This node represents a node in a constructed AST where introspection is not possible. At the moment, it’s only used in the args attribute of FunctionDef nodes where function signature introspection failed.

Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

qname()[source]
name = 'Unknown'
class astroid.nodes.While(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.MultiLineBlockMixin, astroid.mixins.BlockRangeMixIn, astroid.nodes.node_classes.Statement

Class representing an ast.While node.

>>> import astroid
>>> node = astroid.extract_node('''
while condition():
    print("True")
''')
>>> node
<While l.2 at 0x7f23b2e4e390>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

block_range(lineno)[source]

Get a range from the given line number to where this node ends.

Parameters

lineno (int) – The line number to start the range at.

Returns

The range of line numbers that this node belongs to, starting at the given line number.

Return type

tuple(int, int)

get_children()[source]

Get the child nodes below this node.

postinit(test=None, body=None, orelse=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

blockstart_tolineno

<wrapped by the cachedproperty decorator> The line on which the beginning of this block ends.

type

int

body: List[NodeNG]

The contents of the loop.

orelse: List[NodeNG]

The contents of the else block.

test: Optional[NodeNG]

The condition that the loop tests.

class astroid.nodes.With(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.mixins.MultiLineBlockMixin, astroid.mixins.BlockRangeMixIn, astroid.mixins.AssignTypeMixin, astroid.nodes.node_classes.Statement

Class representing an ast.With node.

>>> import astroid
>>> node = astroid.extract_node('''
with open(file_path) as file_:
    print(file_.read())
''')
>>> node
<With l.2 at 0x7f23b2e4e710>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

assigned_stmts(node=None, context=None, assign_path=None)

Returns the assigned statement (non inferred) according to the assignment type. See astroid/protocols.py for actual implementation.

Parameters
Return type

Any

get_children()[source]

Get the child nodes below this node.

Returns

The children.

Return type

iterable(NodeNG)

postinit(items=None, body=None, type_annotation=None)[source]

Do some setup after initialisation.

Parameters
Return type

None

blockstart_tolineno

<wrapped by the cachedproperty decorator> The line on which the beginning of this block ends.

type

int

body: List[NodeNG]

The contents of the with block.

items: List[Tuple[NodeNG, Optional[NodeNG]]]

The pairs of context managers and the names they are assigned to.

type_annotation: Optional[NodeNG]

If present, this will contain the type annotation passed by a type comment

class astroid.nodes.Yield(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_ng.NodeNG

Class representing an ast.Yield node.

>>> import astroid
>>> node = astroid.extract_node('yield True')
>>> node
<Yield l.1 at 0x7f23b2e4e5f8>
Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

get_children()[source]

Get the child nodes below this node.

postinit(value=None)[source]

Do some setup after initialisation.

Parameters

value (Optional[astroid.nodes.node_ng.NodeNG]) – The value to yield.

Return type

None

value: Optional[NodeNG]

The value to yield.

class astroid.nodes.YieldFrom(lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None)[source]

Bases: astroid.nodes.node_classes.Yield

Class representing an ast.YieldFrom node.

Parameters

  • lineno (Optional[int]) – The line that this node appears on in the source code.

  • col_offset (Optional[int]) – The column that this node appears on in the source code.

  • parent (Optional[astroid.nodes.node_ng.NodeNG]) – The parent node in the syntax tree.

  • end_lineno (Optional[int]) – The last line this node appears on in the source code.

  • end_col_offset (Optional[int]) – The end column this node appears on in the source code. Note: This is after the last symbol.

Return type

None

col_offset: Optional[int]

The column that this node appears on in the source code.

end_col_offset: Optional[int]

The end column this node appears on in the source code. Note: This is after the last symbol.

end_lineno: Optional[int]

The last line this node appears on in the source code.

lineno: Optional[int]

The line that this node appears on in the source code.

parent: Optional['NodeNG']

The parent node in the syntax tree.

position: Optional[Position]

Position of keyword(s) and name. Used as fallback for block nodes which might not provide good enough positional information. E.g. ClassDef, FunctionDef.

value: Optional[NodeNG]

The value to yield.