class documentation

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>]

Method __getattr__ Undocumented
Method __init__ :param value: The value that the constant represents.
Method bool_value Determine the boolean value of this node.
Method getitem Get an item from this node if subscriptable.
Method has_dynamic_getattr Check if the node has a custom __getattr__ or __getattribute__.
Method itered An iterator over the elements this node contains.
Method pytype Get the name of the type that this node represents.
Class Variable infer_binary_op Undocumented
Class Variable infer_unary_op Undocumented
Instance Variable kind "The string prefix. "u" for u-prefixed strings and ``None`` otherwise. Python 3.8+ only.
Instance Variable value The value that the constant represents.
Class Variable _other_fields Node attributes that do not contain child nodes.

Inherited from NoChildrenMixin:

Method get_children Get the child nodes below this node.

Inherited from NodeNG (via NoChildrenMixin):

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 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.
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.
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.
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.
Instance Variable position Position of keyword(s) and name.
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 _astroid_fields Node attributes that contain child nodes.
Class Variable _explicit_inference Undocumented
Class Variable _other_other_fields Attributes that contain AST-dependent fields.
def __getattr__(self, name): (source)

Undocumented

def __init__(self, value: Any, lineno: int|None = None, col_offset: int|None = None, parent: NodeNG|None = None, kind: str|None = None, *, end_lineno: int|None = None, end_col_offset: int|None = None): (source)

:param value: The value that the constant represents. :param lineno: The line that this node appears on in the source code. :param col_offset: The column that this node appears on in the source code. :param parent: The parent node in the syntax tree. :param kind: The string prefix. "u" for u-prefixed strings and ``None`` otherwise. Python 3.8+ only. :param end_lineno: The last line this node appears on in the source code. :param end_col_offset: The end column this node appears on in the source code. Note: This is after the last symbol.

def bool_value(self, context: InferenceContext|None = None): (source)

Determine the boolean value of this node. :returns: The boolean value of this node. :rtype: bool

def getitem(self, index, context: InferenceContext|None = None): (source)

Get an item from this node if subscriptable. :param index: The node to use as a subscript index. :type index: Const or Slice :raises AstroidTypeError: When the given index cannot be used as a subscript index, or if this node is not subscriptable.

def has_dynamic_getattr(self) -> bool: (source)

Check if the node has a custom __getattr__ or __getattribute__. :returns: Whether the class has a custom __getattr__ or __getattribute__. For a :class:`Const` this is always ``False``.

def itered(self): (source)

An iterator over the elements this node contains. :returns: The contents of this node. :rtype: iterable(Const) :raises TypeError: If this node does not represent something that is iterable.

def pytype(self) -> str: (source)

Get the name of the type that this node represents. :returns: The name of the type.

infer_binary_op: ClassVar[InferBinaryOp[Const]] = (source)

Undocumented

infer_unary_op: ClassVar[InferUnaryOp[Const]] = (source)

Undocumented

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

value: Any = (source)

The value that the constant represents.

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

Node attributes that do not contain child nodes.