Class Hierarchy

astroid.arguments.CallSite - Class for understanding arguments passed into a call site
astroid.bases.Proxy - a simple proxy object
- astroid.bases.BaseInstance - An instance base class, which provides lookup methods for potential instances.
  - astroid.bases.Generator - a special node representing a generator.
    - astroid.bases.AsyncGenerator - Special node representing an async generator
  - astroid.bases.Instance - A special node representing a class instance.
    - astroid.nodes.Const - Class representing any constant including num, str, bool, None, bytes.
    - astroid.nodes.Dict - Class representing an ast.Dict node.
    - astroid.nodes.node_classes.BaseContainer - Base class for Set, FrozenSet, Tuple and List.
      - astroid.nodes.List - Class representing an ast.List node.
      - astroid.nodes.Set - Class representing an ast.Set node.
      - astroid.nodes.Tuple - Class representing an ast.Tuple node.
      - astroid.objects.FrozenSet - class representing a FrozenSet composite node
    - astroid.objects.DictInstance - Special kind of instances for dictionaries
    - astroid.objects.ExceptionInstance - Class for instances of exceptions
- astroid.bases.UnboundMethod - a special node representing a method not bound to an instance
  - astroid.bases.BoundMethod - a special node representing a method bound to an instance
- astroid.objects.DictItems - Undocumented
- astroid.objects.DictKeys - Undocumented
- astroid.objects.DictValues - Undocumented
astroid.context.CallContext - Holds information for a call site.
astroid.context.InferenceContext - Provide context for inference
astroid.decorators.cachedproperty - Provides a cached property equivalent to the stacking of @cached and @property, but more efficient.
astroid.interpreter._import.spec._ModuleSpec
- astroid.interpreter._import.spec.ModuleSpec - Defines a class similar to PEP 420's ModuleSpec
astroid.interpreter._import.spec.Finder - A finder is a class which knows how to find a particular module.
- astroid.interpreter._import.spec.ImportlibFinder - A finder based on the importlib module.
  - astroid.interpreter._import.spec.ExplicitNamespacePackageFinder - A finder for the explicit namespace packages, generated through pkg_resources.
- astroid.interpreter._import.spec.PathSpecFinder - Finder based on importlib.machinery.PathFinder.
- astroid.interpreter._import.spec.ZipFinder - Finder that knows how to find a module inside zip files.
astroid.interpreter.objectmodel.ObjectModel - No class docstring; 0/1 instance variable, 2/7 methods documented
- astroid.interpreter.objectmodel.ClassModel - No class docstring; 1/10 property, 0/1 instance variable, 0/1 method documented
- astroid.interpreter.objectmodel.DictModel - No class docstring; 0/4 property, 1/1 method documented
- astroid.interpreter.objectmodel.FunctionModel - Undocumented
  - astroid.brain.brain_functools.LruWrappedModel - Special attribute model for functions decorated with functools.lru_cache.
  - astroid.interpreter.objectmodel.BoundMethodModel - Undocumented
  - astroid.interpreter.objectmodel.GeneratorModel - Undocumented
    - astroid.interpreter.objectmodel.AsyncGeneratorModel - Undocumented
- astroid.interpreter.objectmodel.InstanceModel - Undocumented
  - astroid.interpreter.objectmodel.ExceptionInstanceModel - Undocumented
    - astroid.interpreter.objectmodel.ImportErrorInstanceModel - Undocumented
    - astroid.interpreter.objectmodel.OSErrorInstanceModel - Undocumented
    - astroid.interpreter.objectmodel.SyntaxErrorInstanceModel - Undocumented
    - astroid.interpreter.objectmodel.UnicodeDecodeErrorInstanceModel - Undocumented
- astroid.interpreter.objectmodel.ModuleModel - Undocumented
- astroid.interpreter.objectmodel.PropertyModel - Model for a builtin property
- astroid.interpreter.objectmodel.SuperModel - Undocumented
- astroid.interpreter.objectmodel.UnboundMethodModel - Undocumented
astroid.manager.AstroidManager - Responsible to build astroid from files or modules.
astroid.mixins.AssignTypeMixin - No class docstring; 1/2 method documented
- astroid.mixins.ParentAssignTypeMixin - Undocumented
  - astroid.nodes.AssignAttr - Variation of ast.Assign representing assignment to an attribute.
  - astroid.nodes.AssignName - Variation of ast.Assign representing assignment to a name.
  - astroid.nodes.DelAttr - Variation of ast.Delete representing deletion of an attribute.
  - astroid.nodes.DelName - Variation of ast.Delete representing deletion of a name.
  - astroid.nodes.node_classes.BaseContainer - Base class for Set, FrozenSet, Tuple and List.
    - astroid.nodes.List - Class representing an ast.List node.
    - astroid.nodes.Set - Class representing an ast.Set node.
    - astroid.nodes.Tuple - Class representing an ast.Tuple node.
    - astroid.objects.FrozenSet - class representing a FrozenSet composite node
  - astroid.nodes.Starred - Class representing an ast.Starred node.
- astroid.nodes.AnnAssign - Class representing an ast.AnnAssign node.
- astroid.nodes.Arguments - Class representing an ast.arguments node.
- astroid.nodes.Assign - Class representing an ast.Assign node.
- astroid.nodes.AugAssign - Class representing an ast.AugAssign node.
- astroid.nodes.Delete - Class representing an ast.Delete node.
- astroid.nodes.ExceptHandler - Class representing an ast.ExceptHandler. node.
- astroid.nodes.For - Class representing an ast.For node.
  - astroid.nodes.AsyncFor - Class representing an ast.AsyncFor node.
- astroid.nodes.MatchAs - Class representing a ast.MatchAs node.
- astroid.nodes.MatchMapping - Class representing a ast.MatchMapping node.
- astroid.nodes.MatchStar - Class representing a ast.MatchStar node.
- astroid.nodes.NamedExpr - Represents the assignment from the assignment expression
- astroid.nodes.Unknown - This node represents a node in a constructed AST where introspection is not possible. At the moment, it's only used in the args attribute of FunctionDef nodes where function signature introspection failed.
- astroid.nodes.With - Class representing an ast.With node.
  - astroid.nodes.AsyncWith - Asynchronous with built with the async keyword.
astroid.mixins.BlockRangeMixIn - override block range
- astroid.nodes.For - Class representing an ast.For node.
  - astroid.nodes.AsyncFor - Class representing an ast.AsyncFor node.
- astroid.nodes.If - Class representing an ast.If node.
- astroid.nodes.TryExcept - Class representing an ast.TryExcept node.
- astroid.nodes.TryFinally - Class representing an ast.TryFinally node.
- astroid.nodes.While - Class representing an ast.While node.
- astroid.nodes.With - Class representing an ast.With node.
  - astroid.nodes.AsyncWith - Asynchronous with built with the async keyword.
astroid.mixins.FilterStmtsMixin - Mixin for statement filtering and assignment type
- astroid.mixins.ImportFromMixin - MixIn for From and Import Nodes
  - astroid.nodes.Import - Class representing an ast.Import node. >>> import astroid >>> node = astroid.extract_node('import astroid') >>> node <Import l.1 at 0x7f23b2e4e5c0>
  - astroid.nodes.ImportFrom - Class representing an ast.ImportFrom node.
- astroid.nodes.scoped_nodes.ClassDef - Class representing an ast.ClassDef node.
- astroid.nodes.scoped_nodes.Lambda - Class representing an ast.Lambda node.
  - astroid.nodes.scoped_nodes.FunctionDef - Class representing an ast.FunctionDef.
    - astroid.nodes.scoped_nodes.AsyncFunctionDef - Class representing an ast.FunctionDef node.
    - astroid.objects.PartialFunction - A class representing partial function obtained via functools.partial
    - astroid.objects.Property - Class representing a Python property
astroid.mixins.MultiLineBlockMixin - Mixin for nodes with multi-line blocks, e.g. For and FunctionDef. Note that this does not apply to every node with a body field. For instance, an If node has a multi-line body, but the body of an IfExpr is not multi-line, and hence cannot contain Return nodes, Assign nodes, etc.
- astroid.nodes.ExceptHandler - Class representing an ast.ExceptHandler. node.
- astroid.nodes.For - Class representing an ast.For node.
  - astroid.nodes.AsyncFor - Class representing an ast.AsyncFor node.
- astroid.nodes.If - Class representing an ast.If node.
- astroid.nodes.MatchCase - Class representing a ast.match_case node.
- astroid.nodes.scoped_nodes.FunctionDef - Class representing an ast.FunctionDef.
  - astroid.nodes.scoped_nodes.AsyncFunctionDef - Class representing an ast.FunctionDef node.
  - astroid.objects.PartialFunction - A class representing partial function obtained via functools.partial
  - astroid.objects.Property - Class representing a Python property
- astroid.nodes.TryExcept - Class representing an ast.TryExcept node.
- astroid.nodes.TryFinally - Class representing an ast.TryFinally node.
- astroid.nodes.While - Class representing an ast.While node.
- astroid.nodes.With - Class representing an ast.With node.
  - astroid.nodes.AsyncWith - Asynchronous with built with the async keyword.
astroid.mixins.NoChildrenMixin - Mixin for nodes with no children, e.g. Pass.
- astroid.nodes.AssignName - Variation of ast.Assign representing assignment to a name.
- astroid.nodes.Break - Class representing an ast.Break node.
- astroid.nodes.Const - Class representing any constant including num, str, bool, None, bytes.
- astroid.nodes.Continue - Class representing an ast.Continue node.
- astroid.nodes.DelName - Variation of ast.Delete representing deletion of a name.
- astroid.nodes.DictUnpack - Represents the unpacking of dicts into dicts using PEP 448.
- astroid.nodes.Ellipsis - Class representing an ast.Ellipsis node.
- astroid.nodes.EmptyNode - Holds an arbitrary object in the LocalsDictNodeNG.locals.
- astroid.nodes.Global - Class representing an ast.Global node.
- astroid.nodes.Import - Class representing an ast.Import node. >>> import astroid >>> node = astroid.extract_node('import astroid') >>> node <Import l.1 at 0x7f23b2e4e5c0>
- astroid.nodes.ImportFrom - Class representing an ast.ImportFrom node.
- astroid.nodes.Name - Class representing an ast.Name node.
- astroid.nodes.Nonlocal - Class representing an ast.Nonlocal node.
- astroid.nodes.Pass - Class representing an ast.Pass node.
astroid.nodes.as_string.AsStringVisitor - Visitor to render an Astroid node as a valid python code string
astroid.nodes.node_classes.LookupMixIn - Mixin to look up a name in the right scope.
- astroid.nodes.AssignName - Variation of ast.Assign representing assignment to a name.
- astroid.nodes.DelName - Variation of ast.Delete representing deletion of a name.
- astroid.nodes.Name - Class representing an ast.Name node.
- astroid.nodes.scoped_nodes.LocalsDictNodeNG - this class provides locals handling common to Module, FunctionDef and ClassDef nodes, including a dict like interface for direct access to locals information
  - astroid.nodes.scoped_nodes.ClassDef - Class representing an ast.ClassDef node.
  - astroid.nodes.scoped_nodes.ComprehensionScope - Scoping for different types of comprehensions.
    - astroid.nodes.scoped_nodes.DictComp - Class representing an ast.DictComp node.
    - astroid.nodes.scoped_nodes.GeneratorExp - Class representing an ast.GeneratorExp node.
    - astroid.nodes.scoped_nodes.ListComp - Class representing an ast.ListComp node.
    - astroid.nodes.scoped_nodes.SetComp - Class representing an ast.SetComp node.
  - astroid.nodes.scoped_nodes.Lambda - Class representing an ast.Lambda node.
    - astroid.nodes.scoped_nodes.FunctionDef - Class representing an ast.FunctionDef.
      - astroid.nodes.scoped_nodes.AsyncFunctionDef - Class representing an ast.FunctionDef node.
      - astroid.objects.PartialFunction - A class representing partial function obtained via functools.partial
      - astroid.objects.Property - Class representing a Python property
  - astroid.nodes.scoped_nodes.Module - Class representing an ast.Module node.
astroid.nodes.node_ng.NodeNG
- astroid.nodes.scoped_nodes.LocalsDictNodeNG - this class provides locals handling common to Module, FunctionDef and ClassDef nodes, including a dict like interface for direct access to locals information
  - astroid.nodes.scoped_nodes.ClassDef - Class representing an ast.ClassDef node.
  - astroid.nodes.scoped_nodes.ComprehensionScope - Scoping for different types of comprehensions.
    - astroid.nodes.scoped_nodes.DictComp - Class representing an ast.DictComp node.
    - astroid.nodes.scoped_nodes.GeneratorExp - Class representing an ast.GeneratorExp node.
    - astroid.nodes.scoped_nodes.ListComp - Class representing an ast.ListComp node.
    - astroid.nodes.scoped_nodes.SetComp - Class representing an ast.SetComp node.
  - astroid.nodes.scoped_nodes.Lambda - Class representing an ast.Lambda node.
    - astroid.nodes.scoped_nodes.FunctionDef - Class representing an ast.FunctionDef.
      - astroid.nodes.scoped_nodes.AsyncFunctionDef - Class representing an ast.FunctionDef node.
      - astroid.objects.PartialFunction - A class representing partial function obtained via functools.partial
      - astroid.objects.Property - Class representing a Python property
  - astroid.nodes.scoped_nodes.Module - Class representing an ast.Module node.
- astroid.nodes.scoped_nodes.scoped_nodes._ListComp - Class representing an ast.ListComp node.
  - astroid.nodes.scoped_nodes.ListComp - Class representing an ast.ListComp node.
- astroid.objects.Super - Proxy class over a super call.
astroid.nodes.NodeNG - A node of the new Abstract Syntax Tree (AST).
- astroid.nodes.Arguments - Class representing an ast.arguments node.
- astroid.nodes.AssignAttr - Variation of ast.Assign representing assignment to an attribute.
- astroid.nodes.AssignName - Variation of ast.Assign representing assignment to a name.
- astroid.nodes.Attribute - Class representing an ast.Attribute node.
- astroid.nodes.Await - Class representing an ast.Await node.
- astroid.nodes.BinOp - Class representing an ast.BinOp node.
- astroid.nodes.BoolOp - Class representing an ast.BoolOp node.
- astroid.nodes.Call - Class representing an ast.Call node.
- astroid.nodes.Compare - Class representing an ast.Compare node.
- astroid.nodes.Comprehension - Class representing an ast.comprehension node.
- astroid.nodes.Const - Class representing any constant including num, str, bool, None, bytes.
- astroid.nodes.Decorators - A node representing a list of decorators.
- astroid.nodes.DelAttr - Variation of ast.Delete representing deletion of an attribute.
- astroid.nodes.DelName - Variation of ast.Delete representing deletion of a name.
- astroid.nodes.Dict - Class representing an ast.Dict node.
- astroid.nodes.DictUnpack - Represents the unpacking of dicts into dicts using PEP 448.
- astroid.nodes.Ellipsis - Class representing an ast.Ellipsis node.
- astroid.nodes.EmptyNode - Holds an arbitrary object in the LocalsDictNodeNG.locals.
- astroid.nodes.EvaluatedObject - Contains an object that has already been inferred
- astroid.nodes.ExtSlice - Class representing an ast.ExtSlice node.
- astroid.nodes.FormattedValue - Class representing an ast.FormattedValue node.
- astroid.nodes.IfExp - Class representing an ast.IfExp node. >>> import astroid >>> node = astroid.extract_node('value if condition else other') >>> node <IfExp l.1 at 0x7f23b2e9dbe0>
- astroid.nodes.Index - Class representing an ast.Index node.
- astroid.nodes.JoinedStr - Represents a list of string expressions to be joined.
- astroid.nodes.Keyword - Class representing an ast.keyword node.
- astroid.nodes.MatchCase - Class representing a ast.match_case node.
- astroid.nodes.Name - Class representing an ast.Name node.
- astroid.nodes.NamedExpr - Represents the assignment from the assignment expression
- astroid.nodes.node_classes.BaseContainer - Base class for Set, FrozenSet, Tuple and List.
  - astroid.nodes.List - Class representing an ast.List node.
  - astroid.nodes.Set - Class representing an ast.Set node.
  - astroid.nodes.Tuple - Class representing an ast.Tuple node.
  - astroid.objects.FrozenSet - class representing a FrozenSet composite node
- astroid.nodes.node_classes.Pattern - Base class for all Pattern nodes.
  - astroid.nodes.MatchAs - Class representing a ast.MatchAs node.
  - astroid.nodes.MatchClass - Class representing a ast.MatchClass node.
  - astroid.nodes.MatchMapping - Class representing a ast.MatchMapping node.
  - astroid.nodes.MatchOr - Class representing a ast.MatchOr node.
  - astroid.nodes.MatchSequence - Class representing a ast.MatchSequence node.
  - astroid.nodes.MatchSingleton - Class representing a ast.MatchSingleton node.
  - astroid.nodes.MatchStar - Class representing a ast.MatchStar node.
  - astroid.nodes.MatchValue - Class representing a ast.MatchValue node.
- astroid.nodes.Slice - Class representing an ast.Slice node.
- astroid.nodes.Starred - Class representing an ast.Starred node.
- astroid.nodes.Statement - Statement node adding a few attributes
  - astroid.nodes.AnnAssign - Class representing an ast.AnnAssign node.
  - astroid.nodes.Assert - Class representing an ast.Assert node.
  - astroid.nodes.Assign - Class representing an ast.Assign node.
  - astroid.nodes.AugAssign - Class representing an ast.AugAssign node.
  - astroid.nodes.Break - Class representing an ast.Break node.
  - astroid.nodes.Continue - Class representing an ast.Continue node.
  - astroid.nodes.Delete - Class representing an ast.Delete node.
  - astroid.nodes.ExceptHandler - Class representing an ast.ExceptHandler. node.
  - astroid.nodes.Expr - Class representing an ast.Expr node.
  - astroid.nodes.For - Class representing an ast.For node.
    - astroid.nodes.AsyncFor - Class representing an ast.AsyncFor node.
  - astroid.nodes.Global - Class representing an ast.Global node.
  - astroid.nodes.If - Class representing an ast.If node.
  - astroid.nodes.Import - Class representing an ast.Import node. >>> import astroid >>> node = astroid.extract_node('import astroid') >>> node <Import l.1 at 0x7f23b2e4e5c0>
  - astroid.nodes.ImportFrom - Class representing an ast.ImportFrom node.
  - astroid.nodes.Match - Class representing a ast.Match node.
  - astroid.nodes.Nonlocal - Class representing an ast.Nonlocal node.
  - astroid.nodes.Pass - Class representing an ast.Pass node.
  - astroid.nodes.Raise - Class representing an ast.Raise node.
  - astroid.nodes.Return - Class representing an ast.Return node.
  - astroid.nodes.scoped_nodes.ClassDef - Class representing an ast.ClassDef node.
  - astroid.nodes.scoped_nodes.FunctionDef - Class representing an ast.FunctionDef.
    - astroid.nodes.scoped_nodes.AsyncFunctionDef - Class representing an ast.FunctionDef node.
    - astroid.objects.PartialFunction - A class representing partial function obtained via functools.partial
    - astroid.objects.Property - Class representing a Python property
  - astroid.nodes.TryExcept - Class representing an ast.TryExcept node.
  - astroid.nodes.TryFinally - Class representing an ast.TryFinally node.
  - astroid.nodes.While - Class representing an ast.While node.
  - astroid.nodes.With - Class representing an ast.With node.
    - astroid.nodes.AsyncWith - Asynchronous with built with the async keyword.
- astroid.nodes.Subscript - Class representing an ast.Subscript node.
- astroid.nodes.UnaryOp - Class representing an ast.UnaryOp node.
- astroid.nodes.Unknown - This node represents a node in a constructed AST where introspection is not possible. At the moment, it's only used in the args attribute of FunctionDef nodes where function signature introspection failed.
- astroid.nodes.Yield - Class representing an ast.Yield node.
  - astroid.nodes.YieldFrom - Class representing an ast.YieldFrom node.
astroid.raw_building.InspectBuilder - class for building nodes from living object
- astroid.builder.AstroidBuilder - Class for building an astroid tree from source code or from a live module.
astroid.rebuilder.TreeRebuilder - Rebuilds the _ast tree to become an Astroid tree
astroid.transforms.TransformVisitor - A visitor for handling transforms.
astroid.util.BadOperationMessage - Object which describes a TypeError occurred somewhere in the inference chain
- astroid.util.BadBinaryOperationMessage - Object which describes type errors for BinOps.
- astroid.util.BadUnaryOperationMessage - Object which describes operational failures on UnaryOps.
astroid.util.Uninferable - Special inference object, which is returned when inference fails.
enum.Enum
- astroid.const.Context - Undocumented
Exception
- astroid.exceptions._NonDeducibleTypeHierarchy - Raised when is_subtype / is_supertype can't deduce the relation between two types.
- astroid.exceptions.AstroidError - base exception class for all astroid related exceptions
  - astroid.exceptions.AstroidBuildingError - exception class when we are unable to build an astroid representation
    - astroid.exceptions.AstroidImportError - Exception class used when a module can't be imported by astroid.
      - astroid.exceptions.TooManyLevelsError - Exception class which is raised when a relative import was beyond the top-level.
    - astroid.exceptions.AstroidSyntaxError - Exception class used when a module can't be parsed.
  - astroid.exceptions.AstroidIndexError - Raised when an Indexable / Mapping does not have an index / key.
  - astroid.exceptions.AstroidTypeError - Raised when a TypeError would be expected in Python code.
  - astroid.exceptions.AstroidValueError - Raised when a ValueError would be expected in Python code.
  - astroid.exceptions.InferenceOverwriteError - Raised when an inference tip is overwritten
  - astroid.exceptions.NoDefault - raised by function's default_value method when an argument has no default value
  - astroid.exceptions.ParentMissingError - Raised when a node which is expected to have a parent attribute is missing one
    - astroid.exceptions.StatementMissing - Raised when a call to node.statement() does not return a node. This is because a node in the chain does not have a parent attribute and therefore does not return a node for statement().
  - astroid.exceptions.ResolveError - Base class of astroid resolution/inference error.
    - astroid.exceptions.AttributeInferenceError - Raised when an attribute lookup fails, corresponds to AttributeError.
    - astroid.exceptions.InferenceError - raised when we are unable to infer a node
      - astroid.exceptions.NameInferenceError - Raised when a name lookup fails, corresponds to NameError.
    - astroid.exceptions.MroError - Error raised when there is a problem with method resolution of a class.
      - astroid.exceptions.DuplicateBasesError - Error raised when there are duplicate bases in the same class bases.
      - astroid.exceptions.InconsistentMroError - Error raised when a class's MRO is inconsistent.
    - astroid.exceptions.SuperError - Error raised when there is a problem with a super call.
- astroid.exceptions.UseInferenceDefault - exception to be raised in custom inference function to indicate that it should go back to the default behaviour
- astroid.modutils.NoSourceFile - exception raised when we are not able to get a python source file for a precompiled file
namedtuple('ParserModule', ['module', 'unary_op_classes', 'cmp_op_classes', 'bool_op_classes', 'bin_op_classes', 'context_classes'])
- astroid._ast.ParserModule - Undocumented