astroid.nodes.scoped

class documentation

class Module(LocalsDictNodeNG): (source)

Class representing an :class:`ast.Module` node. >>> import astroid >>> node = astroid.extract_node('import astroid') >>> node <Import l.1 at 0x7f23b2e4e5c0> >>> node.parent <Module l.0 at 0x7f23b2e4eda0>

Method	`__init__`	:param name: The name of the module.
Method	`absolute_import_activated`	Whether :pep:`328` absolute import behaviour has been enabled.
Method	`block_range`	Get a range from where this node starts to where this node ends.
Method	`bool_value`	Determine the boolean value of this node.
Method	`display_type`	A human readable type of this node.
Method	`doc.setter`	Undocumented
Method	`frame`	The node's frame node.
Method	`fully_defined`	Check if this module has been build from a .py file.
Method	`get_children`	Get the child nodes below this node.
Method	`getattr`	Undocumented
Method	`igetattr`	Infer the possible values of the given variable.
Method	`import_module`	Get the ast for a given module as if imported from this module.
Method	`next_sibling`	The next sibling statement node.
Method	`postinit`	Do some setup after initialisation.
Method	`previous_sibling`	The previous sibling statement.
Method	`public_names`	The list of the names that are publicly available in this module.
Method	`pytype`	Get the name of the type that this node represents.
Method	`relative_to_absolute_name`	Get the absolute module name for a relative import.
Method	`scope_lookup`	Lookup where the given variable is assigned.
Method	`statement`	The first parent node, including self, marked as statement node.
Method	`stream`	Get a stream to the underlying file or bytes.
Method	`wildcard_import_names`	The list of imported names when this module is 'wildcard imported'.
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.
Class Variable	`end_lineno`	The last line this node appears on in the source code.
Class Variable	`file_bytes`	The string/bytes that this ast was built from.
Class Variable	`file_encoding`	The encoding of the source file.
Class Variable	`fromlineno`	The first line that this node appears on in the source code.
Class Variable	`lineno`	The line that this node appears on in the source code.
Class Variable	`parent`	The parent node in the syntax tree.
Class Variable	`scope_attrs`	The names of module attributes available through the global scope.
Class Variable	`special_attributes`	The names of special attributes that this module has.
Instance Variable	`body`	The contents of the module.
Instance Variable	`doc_node`	The doc node associated with this node.
Instance Variable	`file`	The path to the file that this ast has been extracted from.
Instance Variable	`future_imports`	The imports from ``__future__``.
Instance Variable	`globals`	A map of the name of a local variable to the node defining the local.
Instance Variable	`locals`	A map of the name of a local variable to the node defining the local.
Instance Variable	`name`	The name of the module.
Instance Variable	`package`	Whether the node represents a package or a module.
Instance Variable	`path`	Undocumented
Instance Variable	`pure_python`	Whether the ast was built from source.
Property	`doc`	The module docstring.
Method	`_get_stream`	Undocumented
Class Variable	`_absolute_import_activated`	Undocumented
Class Variable	`_astroid_fields`	Node attributes that contain child nodes.
Class Variable	`_other_fields`	Node attributes that do not contain child nodes.
Class Variable	`_other_other_fields`	Attributes that contain AST-dependent fields.
Instance Variable	`_doc`	The module docstring.

Inherited from LocalsDictNodeNG:

Method	`__contains__`	Check if a local is defined in this scope.
Method	`__getitem__`	The first node the defines the given local.
Method	`__iter__`	Iterate over the names of locals defined in this scoped node.
Method	`add_local_node`	Append a child that should alter the locals of this scope node.
Method	`items`	Get the names of the locals and the node that defines the local.
Method	`keys`	The names of locals defined in this scoped node.
Method	`qname`	Get the 'qualified' name of the node.
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	`values`	The nodes that define the locals in this scoped node.
Method	`_append_node`	append a child, linking it in the tree
Method	`_scope_lookup`	XXX method for interfacing the scope lookup

Inherited from LookupMixIn (via LocalsDictNodeNG):

Method	`ilookup`	Lookup the inferred values of the given variable.
Method	`lookup`	Lookup where the given variable is assigned.

Inherited from NodeNG (via LocalsDictNodeNG, LookupMixIn):

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	`callable`	Whether this node defines something that is callable.
Method	`child_sequence`	Search for the sequence that contains this child.
Method	`eq`	Undocumented
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.
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	`position`	Position of keyword(s) and name.
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

@decorators_mod.deprecate_arguments(doc='Use the postinit arg \'doc_node\' instead')
def __init__(self, name: str, doc: str|None = None, file: str|None = None, path: list[str]|None = None, package: bool|None = None, parent: None = None, pure_python: bool|None = True): (source) ¶

overrides astroid.nodes.NodeNG.__init__

:param name: The name of the module. :param doc: The module docstring. :param file: The path to the file that this ast has been extracted from. :param path: :param package: Whether the node represents a package or a module. :param parent: The parent node in the syntax tree. :param pure_python: Whether the ast was built from source.

def absolute_import_activated(self) -> bool: (source) ¶

Whether :pep:`328` absolute import behaviour has been enabled. :returns: Whether :pep:`328` has been enabled.

def block_range(self, lineno): (source) ¶

overrides astroid.nodes.NodeNG.block_range

Get a range from where this node starts to where this node ends. :param lineno: Unused. :type lineno: int :returns: The range of line numbers that this node belongs to. :rtype: tuple(int, int)

def bool_value(self, context: InferenceContext|None = None) -> bool: (source) ¶

overrides astroid.nodes.NodeNG.bool_value

Determine the boolean value of this node. :returns: The boolean value of this node. For a :class:`Module` this is always ``True``.

def display_type(self) -> str: (source) ¶

A human readable type of this node. :returns: The type of this node. :rtype: str

@doc.setter
def doc(self, value: str|None): (source) ¶

Undocumented

def frame(self: _T, *, future: Literal[None, True] = None) -> _T: (source) ¶

overrides astroid.nodes.NodeNG.frame

The node's frame node. A frame node is a :class:`Module`, :class:`FunctionDef`, :class:`ClassDef` or :class:`Lambda`. :returns: The node itself.

def fully_defined(self) -> bool: (source) ¶

Check if this module has been build from a .py file. If so, the module contains a complete representation, including the code. :returns: Whether the module has been built from a .py file.

def get_children(self): (source) ¶

overrides astroid.nodes.NodeNG.get_children

Get the child nodes below this node.

def getattr(self, name, context: InferenceContext|None = None, ignore_locals=False): (source) ¶

Undocumented

def igetattr(self, name, context: InferenceContext|None = None): (source) ¶

Infer the possible values of the given variable. :param name: The name of the variable to infer. :type name: str :returns: The inferred possible values. :rtype: iterable(NodeNG) or None

def import_module(self, modname: str|None, relative_only: bool = False, level: int|None = None, use_cache: bool = True) -> Module: (source) ¶

Get the ast for a given module as if imported from this module. :param modname: The name of the module to "import". :param relative_only: Whether to only consider relative imports. :param level: The level of relative import. :param use_cache: Whether to use the astroid_cache of modules. :returns: The imported module ast.

def next_sibling(self): (source) ¶

overrides astroid.nodes.NodeNG.next_sibling

The next sibling statement node. :returns: The next sibling statement node. :rtype: NodeNG or None

def postinit(self, body=None, *, doc_node: Const|None = None): (source) ¶

Do some setup after initialisation. :param body: The contents of the module. :type body: list(NodeNG) or None :param doc_node: The doc node associated with this node.

def previous_sibling(self): (source) ¶

overrides astroid.nodes.NodeNG.previous_sibling

The previous sibling statement. :returns: The previous sibling statement node. :rtype: NodeNG or None

def public_names(self): (source) ¶

The list of the names that are publicly available in this module. :returns: The list of public names. :rtype: list(str)

def pytype(self) -> Literal['builtins.module']: (source) ¶

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

def relative_to_absolute_name(self, modname: str|None, level: int|None) -> str|None: (source) ¶

Get the absolute module name for a relative import. The relative import can be implicit or explicit. :param modname: The module name to convert. :param level: The level of relative import. :returns: The absolute module name. :raises TooManyLevelsError: When the relative import refers to a module too far above this one.

def scope_lookup(self, node, name, offset=0): (source) ¶

overrides astroid.nodes.scoped_nodes.LocalsDictNodeNG.scope_lookup

Lookup where the given variable is assigned. :param node: The node to look for assignments up to. Any assignments after the given node are ignored. :type node: NodeNG :param name: The name of the variable to find assignments for. :type name: str :param offset: The line offset to filter statements up to. :type offset: int :returns: This scope node and the list of assignments associated to the given name according to the scope where it has been found (locals, globals or builtin). :rtype: tuple(str, list(NodeNG))

@overload

def statement(self, *, future: None = ...) -> Module:

@overload

def statement(self, *, future: Literal[True]) -> NoReturn:

(source) ¶

overrides astroid.nodes.NodeNG.statement

The first parent node, including self, marked as statement node. When called on a :class:`Module` with the future parameter this raises an error. TODO: Deprecate the future parameter and only raise StatementMissing :raises StatementMissing: If no self has no parent attribute and future is True

def stream(self): (source) ¶

Get a stream to the underlying file or bytes. :type: file or io.BytesIO or None

def wildcard_import_names(self): (source) ¶

The list of imported names when this module is 'wildcard imported'. It doesn't include the '__builtins__' name which is added by the current CPython implementation of wildcard imports. :returns: The list of imported names. :rtype: list(str)

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.

file_bytes: (str|bytes)|None = (source) ¶

The string/bytes that this ast was built from.

file_encoding: str|None = (source) ¶