Exceptions

this module contains exceptions used in the astroid library

Classes

BinaryOperationError

alias of BadBinaryOperationMessage

OperationError

alias of BadOperationMessage

UnaryOperationError

alias of BadUnaryOperationMessage

Exceptions

AstroidBuildingError([message, modname, ...])

exception class when we are unable to build an astroid representation

AstroidBuildingException

alias of AstroidBuildingError

AstroidError([message])

base exception class for all astroid related exceptions

AstroidImportError([message, modname, ...])

Exception class used when a module can't be imported by astroid.

AstroidIndexError([message, node, index, ...])

Raised when an Indexable / Mapping does not have an index / key.

AstroidSyntaxError(message, modname, error, path)

Exception class used when a module can't be parsed.

AstroidTypeError([message, node, index, context])

Raised when a TypeError would be expected in Python code.

AttributeInferenceError([message, ...])

Raised when an attribute lookup fails, corresponds to AttributeError.

DuplicateBasesError(message, mros, cls[, ...])

Error raised when there are duplicate bases in the same class bases.

InconsistentMroError(message, mros, cls[, ...])

Error raised when a class's MRO is inconsistent.

InferenceError([message, node, context, ...])

raised when we are unable to infer a node

MroError(message, mros, cls[, context])

Error raised when there is a problem with method resolution of a class.

NameInferenceError([message, name, scope, ...])

Raised when a name lookup fails, corresponds to NameError.

NoDefault([message, func, name])

raised by function's default_value method when an argument has no default value

NotFoundError

alias of AttributeInferenceError

ParentMissingError(target)

Raised when a node which is expected to have a parent attribute is missing one

ResolveError([message, context])

Base class of astroid resolution/inference error.

SuperArgumentTypeError

alias of SuperError

SuperError(message, super_, **kws)

Error raised when there is a problem with a super call.

TooManyLevelsError([message, level, name])

Exception class which is raised when a relative import was beyond the top-level.

UnresolvableName

alias of NameInferenceError

UseInferenceDefault

exception to be raised in custom inference function to indicate that it should go back to the default behaviour
exception astroid.exceptions.AstroidBuildingError(message='Failed to import module {modname}.', modname=None, error=None, source=None, path=None, cls=None, class_repr=None, **kws)[source]

Bases: AstroidError

exception class when we are unable to build an astroid representation

Standard attributes:

modname: Name of the module that AST construction failed for. error: Exception raised during construction.

Parameters

  • message (str) –

  • modname (str | None) –

  • error (Exception | None) –

  • source (str | None) –

  • path (str | None) –

  • cls (None) –

  • class_repr (str | None) –

  • kws (Any) –

Return type

None

astroid.exceptions.AstroidBuildingException

alias of AstroidBuildingError

exception astroid.exceptions.AstroidError(message='', **kws)[source]

Bases: Exception

base exception class for all astroid related exceptions

AstroidError and its subclasses are structured, intended to hold objects representing state when the exception is thrown. Field values are passed to the constructor as keyword-only arguments. Each subclass has its own set of standard fields, but use your best judgment to decide whether a specific exception instance needs more or fewer fields for debugging. Field values may be used to lazily generate the error message: self.message.format() will be called with the field names and values supplied as keyword arguments.

Parameters

  • message (str) –

  • kws (Any) –

Return type

None

exception astroid.exceptions.AstroidImportError(message='Failed to import module {modname}.', modname=None, error=None, source=None, path=None, cls=None, class_repr=None, **kws)[source]

Bases: AstroidBuildingError

Exception class used when a module can’t be imported by astroid.

Parameters

  • message (str) –

  • modname (str | None) –

  • error (Exception | None) –

  • source (str | None) –

  • path (str | None) –

  • cls (None) –

  • class_repr (str | None) –

  • kws (Any) –

Return type

None

exception astroid.exceptions.AstroidIndexError(message='', node=None, index=None, context=None, **kws)[source]

Bases: AstroidError

Raised when an Indexable / Mapping does not have an index / key.

Parameters

  • message (str) –

  • node (nodes.NodeNG | bases.Instance | None) –

  • index (nodes.Subscript | None) –

  • context (InferenceContext | None) –

  • kws (Any) –

Return type

None

exception astroid.exceptions.AstroidSyntaxError(message, modname, error, path, source=None)[source]

Bases: AstroidBuildingError

Exception class used when a module can’t be parsed.

Parameters

  • message (str) –

  • modname (str) –

  • error (Exception) –

  • path (str | None) –

  • source (str | None) –

Return type

None

exception astroid.exceptions.AstroidTypeError(message='', node=None, index=None, context=None, **kws)[source]

Bases: AstroidError

Raised when a TypeError would be expected in Python code.

Parameters

  • message (str) –

  • node (nodes.NodeNG | bases.Instance | None) –

  • index (nodes.Subscript | None) –

  • context (InferenceContext | None) –

  • kws (Any) –

Return type

None

exception astroid.exceptions.AstroidValueError(message='', **kws)[source]

Bases: AstroidError

Raised when a ValueError would be expected in Python code.

Parameters

  • message (str) –

  • kws (Any) –

Return type

None

exception astroid.exceptions.AttributeInferenceError(message='{attribute!r} not found on {target!r}.', attribute='', target=None, context=None, mros=None, super_=None, cls=None, **kws)[source]

Bases: ResolveError

Raised when an attribute lookup fails, corresponds to AttributeError.

Standard attributes:

target: The node for which lookup failed. attribute: The attribute for which lookup failed, as a string. context: InferenceContext object.

Parameters
Return type

None

exception astroid.exceptions.DuplicateBasesError(message, mros, cls, context=None, **kws)[source]

Bases: MroError

Error raised when there are duplicate bases in the same class bases.

Parameters
Return type

None

exception astroid.exceptions.InconsistentMroError(message, mros, cls, context=None, **kws)[source]

Bases: MroError

Error raised when a class’s MRO is inconsistent.

Parameters
Return type

None

exception astroid.exceptions.InferenceError(message='Inference failed for {node!r}.', node=None, context=None, target=None, targets=None, attribute=None, unknown=None, assign_path=None, caller=None, stmts=None, frame=None, call_site=None, func=None, arg=None, positional_arguments=None, unpacked_args=None, keyword_arguments=None, unpacked_kwargs=None, **kws)[source]

Bases: ResolveError

raised when we are unable to infer a node

Standard attributes:

node: The node inference was called on. context: InferenceContext object.

Parameters

  • message (str) –

  • node (nodes.NodeNG | bases.Instance | None) –

  • context (InferenceContext | None) –

  • target (nodes.NodeNG | bases.Instance | None) –

  • targets (nodes.Tuple | None) –

  • attribute (str | None) –

  • unknown (nodes.NodeNG | bases.Instance | None) –

  • assign_path (list[int] | None) –

  • caller (nodes.Call | None) –

  • stmts (Sequence[nodes.NodeNG | bases.Instance] | None) –

  • frame (nodes.LocalsDictNodeNG | None) –

  • call_site (arguments.CallSite | None) –

  • func (nodes.FunctionDef | None) –

  • arg (str | None) –

  • positional_arguments (list | None) –

  • unpacked_args (list | None) –

  • keyword_arguments (dict | None) –

  • unpacked_kwargs (dict | None) –

  • kws (Any) –

Return type

None

exception astroid.exceptions.InferenceOverwriteError(message='', **kws)[source]

Bases: AstroidError

Raised when an inference tip is overwritten

Currently only used for debugging.

Parameters

  • message (str) –

  • kws (Any) –

Return type

None

exception astroid.exceptions.MroError(message, mros, cls, context=None, **kws)[source]

Bases: ResolveError

Error raised when there is a problem with method resolution of a class.

Standard attributes:

mros: A sequence of sequences containing ClassDef nodes. cls: ClassDef node whose MRO resolution failed. context: InferenceContext object.

Parameters
Return type

None

exception astroid.exceptions.NameInferenceError(message='{name!r} not found in {scope!r}.', name=None, scope=None, context=None, **kws)[source]

Bases: InferenceError

Raised when a name lookup fails, corresponds to NameError.

Standard attributes:

name: The name for which lookup failed, as a string. scope: The node representing the scope in which the lookup occurred. context: InferenceContext object.

Parameters

  • message (str) –

  • name (str | None) –

  • scope (nodes.LocalsDictNodeNG | None) –

  • context (InferenceContext | None) –

  • kws (Any) –

Return type

None

exception astroid.exceptions.NoDefault(message='{func!r} has no default for {name!r}.', func=None, name=None, **kws)[source]

Bases: AstroidError

raised by function’s default_value method when an argument has no default value

Standard attributes:

func: Function node. name: Name of argument without a default.

Parameters

  • message (str) –

  • func (nodes.FunctionDef | None) –

  • name (str | None) –

  • kws (Any) –

Return type

None

astroid.exceptions.NotFoundError

alias of AttributeInferenceError

exception astroid.exceptions.ParentMissingError(target)[source]

Bases: AstroidError

Raised when a node which is expected to have a parent attribute is missing one

Standard attributes:

target: The node for which the parent lookup failed.

Parameters

target (nodes.NodeNG) –

Return type

None

exception astroid.exceptions.ResolveError(message='', context=None, **kws)[source]

Bases: AstroidError

Base class of astroid resolution/inference error.

ResolveError is not intended to be raised.

Standard attributes:

context: InferenceContext object.

Parameters

  • message (str) –

  • context (InferenceContext | None) –

  • kws (Any) –

Return type

None

exception astroid.exceptions.StatementMissing(target)[source]

Bases: ParentMissingError

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().

Standard attributes:

target: The node for which the parent lookup failed.

Parameters

target (nodes.NodeNG) –

Return type

None

astroid.exceptions.SuperArgumentTypeError

alias of SuperError

exception astroid.exceptions.SuperError(message, super_, **kws)[source]

Bases: ResolveError

Error raised when there is a problem with a super call.

Standard attributes:

super_: The Super instance that raised the exception. context: InferenceContext object.

Parameters

  • message (str) –

  • super_ (objects.Super) –

  • kws (Any) –

Return type

None

exception astroid.exceptions.TooManyLevelsError(message='Relative import with too many levels ({level}) for module {name!r}', level=None, name=None, **kws)[source]

Bases: AstroidImportError

Exception class which is raised when a relative import was beyond the top-level.

Standard attributes:

level: The level which was attempted. name: the name of the module on which the relative import was attempted.

Parameters

  • message (str) –

  • level (int | None) –

  • name (str | None) –

  • kws (Any) –

Return type

None

astroid.exceptions.UnresolvableName

alias of NameInferenceError

exception astroid.exceptions.UseInferenceDefault[source]

Bases: Exception

exception to be raised in custom inference function to indicate that it should go back to the default behaviour

astroid.exceptions.BinaryOperationError

alias of BadBinaryOperationMessage

astroid.exceptions.OperationError

alias of BadOperationMessage

astroid.exceptions.UnaryOperationError

alias of BadUnaryOperationMessage