astroid.nodes.Const

class documentation

class Const(mixins.NoChildrenMixin, NodeNG, Instance): (source)

Constructor: Const(value, lineno, col_offset, parent, ...)

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__`	No summary
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.
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 Undocumented

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. 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.
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_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.

Inherited from Instance (via NoChildrenMixin, NodeNG):

Method	`display_type`	Undocumented
Class Variable	`special_attributes`	Undocumented

Inherited from BaseInstance (via NoChildrenMixin, NodeNG, Instance):

Method	`getattr`	Undocumented
Method	`igetattr`	inferred getattr
Method	`infer_call_result`	infer what a class instance is returning when called
Method	`_wrap_attr`	wrap bound methods of attrs in a InstanceMethod proxies

Inherited from Proxy (via NoChildrenMixin, NodeNG, Instance, BaseInstance):

Instance Variable _proxied Undocumented

def __getattr__(self, name): (source) ¶

overrides astroid.bases.Proxy.__getattr__

Undocumented

overrides astroid.nodes.NodeNG.__init__

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

def bool_value(self, context=None): (source) ¶

overrides astroid.nodes.NodeNG.bool_value

Determine the boolean value of this node.

Returns
bool	The boolean value of this node.

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

overrides astroid.bases.Instance.getitem

Get an item from this node if subscriptable.

Parameters
index:Const or Slice	The node to use as a subscript index.
context	Undocumented
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): (source) ¶

Check if the node has a custom __getattr__ or __getattribute__.

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

def itered(self): (source) ¶

An iterator over the elements this node contains.

Returns
iterable(Const)	The contents of this node.
Raises
`TypeError`	If this node does not represent something that is iterable.

def pytype(self): (source) ¶

overrides astroid.bases.Instance.pytype

Get the name of the type that this node represents.

Returns
str	The name of the type.

kind: str | None = (source) ¶

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

value: typing.Any = (source) ¶

The value that the constant represents.

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

overrides astroid.nodes.NodeNG._other_fields

Node attributes that do not contain child nodes.