astroid.nodes.Comprehension

class documentation

class Comprehension(NodeNG): (source)

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'

Method	`__init__`
Method	`assign_type`	The type of assignment that this node performs.
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	`col_offset`	The column that this node appears on in the source code.
Class Variable	`end_col_offset`	The end column this node appears on in the source code. Note: This is after the last symbol.
Class Variable	`end_lineno`	The last line this node appears on in the source code.
Class Variable	`lineno`	The line that this node appears on in the source code.
Class Variable	`optional_assign`	Whether this node optionally assigns a variable.
Instance Variable	`ifs`	The contents of any if statements that filter the comprehension.
Instance Variable	`is_async`	Whether this is an asynchronous comprehension or not.
Instance Variable	`iter`	What is iterated over by the comprehension.
Instance Variable	`target`	What is assigned to by the comprehension.
Method	`_get_filtered_stmts`	method used in filter_stmts
Class Variable	`_astroid_fields`	Node attributes that contain child nodes.
Class Variable	`_other_fields`	Node attributes that do not contain child nodes.

Inherited from NodeNG:

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	`next_sibling`	The next sibling statement node.
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	`previous_sibling`	The previous sibling statement.
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
Class Variable	`is_statement`	Whether this node indicates a statement.
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_other_fields`	Attributes that contain AST-dependent fields.

def __init__(self, parent=None): (source)

overrides astroid.nodes.NodeNG.__init__

Parameters
parent:`Optional[NodeNG]`	The parent node in the syntax tree.

def assign_type(self): (source)

The type of assignment that this node performs.

Returns
NodeNG	The assignment type.

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, ifs=None, is_async=None): (source)

Do some setup after initialisation.

Parameters
target:`Optional[NodeNG]`	What is assigned to by the comprehension.
iter:`Optional[NodeNG]`	What is iterated over by the comprehension.
ifs:`Optional[typing.List[NodeNG]]`	The contents of any if statements that filter the comprehension.
is_async:`Optional[bool]`	Whether this is an asynchronous comprehension or not.

assigned_stmts: AssignedStmtsCall[Comprehension] = (source)

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

col_offset: None = (source)

overrides astroid.nodes.NodeNG.col_offset

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

end_col_offset: None = (source)

overrides astroid.nodes.NodeNG.end_col_offset

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

end_lineno: None = (source)

overrides astroid.nodes.NodeNG.end_lineno

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

lineno: None = (source)

overrides astroid.nodes.NodeNG.lineno

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

optional_assign: bool = (source)

overrides astroid.nodes.NodeNG.optional_assign

Whether this node optionally assigns a variable.

ifs = (source)

The contents of any if statements that filter the comprehension.

is_async = (source)

Whether this is an asynchronous comprehension or not.

iter = (source)

What is iterated over by the comprehension.

target = (source)

What is assigned to by the comprehension.

def _get_filtered_stmts(self, lookup_node, node, stmts, mystmt): (source)

method used in filter_stmts

Parameters
lookup_node	Undocumented
node	Undocumented
stmts	Undocumented
mystmt:`Optional[Statement]`	Undocumented

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

overrides astroid.nodes.NodeNG._astroid_fields

Node attributes that contain child nodes.

This is redefined in most concrete classes.

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

overrides astroid.nodes.NodeNG._other_fields

Node attributes that do not contain child nodes.