astroid.nodes.If

class documentation

class If(mixins.MultiLineBlockMixin, mixins.BlockRangeMixIn, Statement): (source)

Constructor: If(lineno, col_offset, parent, end_lineno, ...)

View In Hierarchy

Class representing an ast.If node.

>>> import astroid
>>> node = astroid.extract_node('if condition: print(True)')
>>> node
<If l.1 at 0x7f23b2e9dd30>
Method __init__ No summary
Method block_range Get a range from the given line number to where this node ends.
Method get_children Get the child nodes below this node.
Method has_elif_block Undocumented
Method is_sys_guard Return True if IF stmt is a sys.version_info guard.
Method is_typing_guard Return True if IF stmt is a typing guard.
Method postinit Do some setup after initialisation.
Instance Variable body The contents of the block.
Instance Variable is_orelse Whether the if-statement is the orelse-block of another if statement.
Instance Variable orelse The contents of the else block.
Instance Variable test The condition that the statement tests.
Property blockstart_tolineno The line on which the beginning of this block ends.
Method _get_yield_nodes_skip_lambdas An If node can contain a Yield node in the test
Class Variable _astroid_fields Node attributes that contain child nodes.
Class Variable _multi_line_block_fields Undocumented

Inherited from MultiLineBlockMixin:

Method _get_assign_nodes Undocumented
Method _get_return_nodes_skip_functions Undocumented
Property _multi_line_blocks Undocumented

Inherited from BlockRangeMixIn (via MultiLineBlockMixin):

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

Inherited from Statement (via MultiLineBlockMixin, BlockRangeMixIn):

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 MultiLineBlockMixin, BlockRangeMixIn, 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 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
Class Variable optional_assign Whether this node optionally assigns a variable.
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_name_nodes 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.
Class Variable _other_other_fields Attributes that contain AST-dependent fields.
def __init__(self, lineno: int | None = None, col_offset: int | None = None, parent: NodeNG | None = None, *, end_lineno: int | None = None, end_col_offset: int | None = None): (source)
overrides astroid.nodes.NodeNG.__init__
Parameters
lineno:int | NoneThe line that this node appears on in the source code.
col_offset:int | NoneThe column that this node appears on in the source code.
parent:NodeNG | NoneThe parent node in the syntax tree.
end_lineno:int | NoneThe last line this node appears on in the source code.
end_col_offset:int | NoneThe end column this node appears on in the source code. Note: This is after the last symbol.
def block_range(self, lineno): (source)
overrides astroid.nodes.NodeNG.block_range

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

Parameters
lineno:intThe line number to start the range at.
Returns
tuple(int, int)The range of line numbers that this node belongs to, starting at the given line number.
def get_children(self): (source)
overrides astroid.nodes.NodeNG.get_children

Get the child nodes below this node.

def has_elif_block(self): (source)

Undocumented

def is_sys_guard(self) -> bool: (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
def is_typing_guard(self) -> bool: (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
def postinit(self, test: NodeNG | None = None, body: list[NodeNG] | None = None, orelse: list[NodeNG] | None = None): (source)

Do some setup after initialisation.

Parameters
test:NodeNG | NoneThe condition that the statement tests.
body:list[NodeNG] | NoneThe contents of the block.
orelse:list[NodeNG] | NoneThe contents of the else block.
body: list[NodeNG] = (source)

The contents of the block.

is_orelse: bool = (source)

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

orelse: list[NodeNG] = (source)

The contents of the else block.

test: NodeNG | None = (source)

The condition that the statement tests.

@decorators.cachedproperty
blockstart_tolineno = (source)
overrides astroid.mixins.BlockRangeMixIn.blockstart_tolineno

The line on which the beginning of this block ends.

def _get_yield_nodes_skip_lambdas(self): (source)
overrides astroid.mixins.MultiLineBlockMixin._get_yield_nodes_skip_lambdas

An If node can contain a Yield node in the test

_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