astroid.nodes.For

class documentation

class For(mixins.MultiLineBlockMixin, mixins.BlockRangeMixIn, mixins.AssignTypeMixin, Statement): (source)

Known subclasses: astroid.nodes.AsyncFor

Class representing an ast.For node.

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

Method	`__init__`
Method	`get_children`	Get the child nodes below this node.
Method	`postinit`	Do some setup after initialisation.
Class Variable	`assigned_stmts`	Returns the assigned statement (non inferred) according to the assignment type. See astroid/protocols.py for actual implementation.
Class Variable	`optional_assign`	Whether this node optionally assigns a variable.
Instance Variable	`body`	The contents of the body of the loop.
Instance Variable	`iter`	What the loop iterates over.
Instance Variable	`orelse`	The contents of the `else` block of the loop.
Instance Variable	`target`	What the loop assigns to.
Instance Variable	`type_annotation`	If present, this will contain the type annotation passed by a type comment
Property	`blockstart_tolineno`	The line on which the beginning of this block ends.
Class Variable	`_astroid_fields`	Node attributes that contain child nodes.
Class Variable	`_multi_line_block_fields`	Undocumented
Class Variable	`_other_other_fields`	Attributes that contain AST-dependent fields.

Inherited from MultiLineBlockMixin:

Method	`_get_assign_nodes`	Undocumented
Method	`_get_return_nodes_skip_functions`	Undocumented
Method	`_get_yield_nodes_skip_lambdas`	Undocumented
Property	`_multi_line_blocks`	Undocumented

Inherited from BlockRangeMixIn:

Method _elsed_block_range handle block line numbers range for try/finally, for, if and while statements

Inherited from AssignTypeMixin:

Method	`assign_type`	Undocumented
Method	`_get_filtered_stmts`	method used in filter_stmts

Inherited from Statement:

Method	`next_sibling`	The next sibling statement node.
Method	`previous_sibling`	The previous sibling statement.
Class Variable	`is_statement`	Whether this node indicates a statement.

Inherited from NodeNG (via Statement):

Method	`__repr__`	Undocumented
Method	`__str__`	Undocumented
Method	`accept`	Visit this node using the given visitor.
Method	`as_string`	Get the source code that this node represents.
Method	`block_range`	Get a range from the given line number to where this node ends.
Method	`bool_value`	Determine the boolean value of this node.
Method	`callable`	Whether this node defines something that is callable.
Method	`child_sequence`	Search for the sequence that contains this child.
Method	`eq`	Undocumented
Method	`frame`	The first parent frame node.
Method	`has_base`	Check if this node inherits from the given type.
Method	`infer`	Get a generator of the inferred values.
Method	`inferred`	Get a list of the inferred values.
Method	`instantiate_class`	Instantiate an instance of the defined class.
Method	`last_child`	An optimized version of list(get_children())[-1]
Method	`locate_child`	Find the field of this node that contains the given child.
Method	`node_ancestors`	Yield parent, grandparent, etc until there are no more.
Method	`nodes_of_class`	Get the nodes (including this one or below) of the given types.
Method	`op_left_associative`	Undocumented
Method	`op_precedence`	Undocumented
Method	`parent_of`	Check if this node is the parent of the given node.
Method	`repr_tree`	Get a string representation of the AST from this node.
Method	`root`	Return the root node of the syntax tree.
Method	`scope`	The first parent node defining a new scope. These can be Module, FunctionDef, ClassDef, Lambda, or GeneratorExp nodes.
Method	`set_local`	Define that the given name is declared in the given statement node.
Method	`statement`	The first parent node, including self, marked as statement node.
Class Variable	`is_function`	Whether this node indicates a function.
Class Variable	`is_lambda`	Undocumented
Instance Variable	`col_offset`	The column that this node appears on in the source code.
Instance Variable	`end_col_offset`	The end column this node appears on in the source code. Note: This is after the last symbol.
Instance Variable	`end_lineno`	The last line this node appears on in the source code.
Instance Variable	`lineno`	The line that this node appears on in the source code.
Instance Variable	`parent`	The parent node in the syntax tree.
Property	`fromlineno`	The first line that this node appears on in the source code.
Property	`tolineno`	The last line that this node appears on in the source code.
Method	`_fixed_source_line`	Attempt to find the line that this node appears on.
Method	`_get_assign_nodes`	Undocumented
Method	`_get_name_nodes`	Undocumented
Method	`_get_return_nodes_skip_functions`	Undocumented
Method	`_get_yield_nodes_skip_lambdas`	Undocumented
Method	`_infer`	we don't know how to resolve a statement by default
Method	`_infer_name`	Undocumented
Method	`_repr_name`	Get a name for nice representation.
Class Variable	`_explicit_inference`	Undocumented
Class Variable	`_other_fields`	Node attributes that do not contain child nodes.

def __init__(self, lineno=None, col_offset=None, parent=None, *, end_lineno=None, end_col_offset=None): (source)

overrides astroid.nodes.NodeNG.__init__

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.

def get_children(self): (source)

overrides astroid.nodes.NodeNG.get_children

Get the child nodes below this node.

def postinit(self, target=None, iter=None, body=None, orelse=None, type_annotation=None): (source)

Do some setup after initialisation.

Parameters
target:`Optional[NodeNG]`	What the loop assigns to.
iter:`Optional[NodeNG]`	What the loop iterates over.
body:`Optional[typing.List[NodeNG]]`	The contents of the body of the loop.
orelse:`Optional[typing.List[NodeNG]]`	The contents of the `else` block of the loop.
type_annotation:`Optional[NodeNG]`	Undocumented

assigned_stmts: AssignedStmtsCall[For] = (source)

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

optional_assign: bool = (source)

overrides astroid.nodes.NodeNG.optional_assign

Whether this node optionally assigns a variable.

This is always True for For nodes.

body = (source)

The contents of the body of the loop.

iter = (source)

What the loop iterates over.

orelse = (source)

The contents of the else block of the loop.

target = (source)

What the loop assigns to.

type_annotation = (source)

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

@decorators.cachedproperty
blockstart_tolineno = (source)

overrides astroid.mixins.BlockRangeMixIn.blockstart_tolineno

The line on which the beginning of this block ends.

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

overrides astroid.nodes.NodeNG._astroid_fields

Node attributes that contain child nodes.

This is redefined in most concrete classes.

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

Undocumented

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

overrides astroid.nodes.NodeNG._other_other_fields

Attributes that contain AST-dependent fields.