exceptions ¤

This module contains all the exceptions specific to Griffe.

Classes:

AliasResolutionError –

Exception for alias that cannot be resolved.
BuiltinModuleError –

Exception raised when trying to access the filepath of a builtin module.
CyclicAliasError –

Exception raised when a cycle is detected in aliases.
ExtensionError –

Base class for errors raised by extensions.
ExtensionNotLoadedError –

Exception raised when an extension could not be loaded.
GitError –

Exception raised for errors related to Git.
GriffeError –

The base exception for all Griffe errors.
LastNodeError –

Exception raised when trying to access a next or previous node.
LoadingError –

The base exception for all Griffe errors.
NameResolutionError –

Exception for names that cannot be resolved in a object scope.
RootNodeError –

Exception raised when trying to use siblings properties on a root node.
UnhandledEditableModuleError –

Exception for unhandled editables modules, when searching modules.
UnimportableModuleError –

Exception for modules that cannot be imported.

AliasResolutionError ¤

AliasResolutionError(alias: Alias)


          flowchart TD
          griffe.exceptions.AliasResolutionError[AliasResolutionError]
          griffe.exceptions.GriffeError[GriffeError]

                        griffe.exceptions.GriffeError --> griffe.exceptions.AliasResolutionError
              


          click griffe.exceptions.AliasResolutionError href "" "griffe.exceptions.AliasResolutionError"
          click griffe.exceptions.GriffeError href "" "griffe.exceptions.GriffeError"

Exception for alias that cannot be resolved.

Parameters:

alias (Alias) –

The alias that could not be resolved.

Attributes:

alias (Alias) –

The alias that triggered the error.

alias `instance-attribute` ¤

alias: Alias = alias

The alias that triggered the error.

BuiltinModuleError ¤


          flowchart TD
          griffe.exceptions.BuiltinModuleError[BuiltinModuleError]
          griffe.exceptions.GriffeError[GriffeError]

                        griffe.exceptions.GriffeError --> griffe.exceptions.BuiltinModuleError
              


          click griffe.exceptions.BuiltinModuleError href "" "griffe.exceptions.BuiltinModuleError"
          click griffe.exceptions.GriffeError href "" "griffe.exceptions.GriffeError"

Exception raised when trying to access the filepath of a builtin module.

CyclicAliasError ¤

CyclicAliasError(chain: list[str])


          flowchart TD
          griffe.exceptions.CyclicAliasError[CyclicAliasError]
          griffe.exceptions.GriffeError[GriffeError]

                        griffe.exceptions.GriffeError --> griffe.exceptions.CyclicAliasError
              


          click griffe.exceptions.CyclicAliasError href "" "griffe.exceptions.CyclicAliasError"
          click griffe.exceptions.GriffeError href "" "griffe.exceptions.GriffeError"

Exception raised when a cycle is detected in aliases.

Parameters:

chain (list[str]) –

The cyclic chain of items (such as target path).

Attributes:

chain (list[str]) –

The chain of aliases that created the cycle.

chain `instance-attribute` ¤

chain: list[str] = chain

The chain of aliases that created the cycle.

ExtensionError ¤


          flowchart TD
          griffe.exceptions.ExtensionError[ExtensionError]
          griffe.exceptions.GriffeError[GriffeError]

                        griffe.exceptions.GriffeError --> griffe.exceptions.ExtensionError
              


          click griffe.exceptions.ExtensionError href "" "griffe.exceptions.ExtensionError"
          click griffe.exceptions.GriffeError href "" "griffe.exceptions.GriffeError"

Base class for errors raised by extensions.

ExtensionNotLoadedError ¤


          flowchart TD
          griffe.exceptions.ExtensionNotLoadedError[ExtensionNotLoadedError]
          griffe.exceptions.ExtensionError[ExtensionError]
          griffe.exceptions.GriffeError[GriffeError]

                        griffe.exceptions.ExtensionError --> griffe.exceptions.ExtensionNotLoadedError
                            griffe.exceptions.GriffeError --> griffe.exceptions.ExtensionError
              



          click griffe.exceptions.ExtensionNotLoadedError href "" "griffe.exceptions.ExtensionNotLoadedError"
          click griffe.exceptions.ExtensionError href "" "griffe.exceptions.ExtensionError"
          click griffe.exceptions.GriffeError href "" "griffe.exceptions.GriffeError"

Exception raised when an extension could not be loaded.

GitError ¤


          flowchart TD
          griffe.exceptions.GitError[GitError]
          griffe.exceptions.GriffeError[GriffeError]

                        griffe.exceptions.GriffeError --> griffe.exceptions.GitError
              


          click griffe.exceptions.GitError href "" "griffe.exceptions.GitError"
          click griffe.exceptions.GriffeError href "" "griffe.exceptions.GriffeError"

Exception raised for errors related to Git.

GriffeError ¤


          flowchart TD
          griffe.exceptions.GriffeError[GriffeError]

          

          click griffe.exceptions.GriffeError href "" "griffe.exceptions.GriffeError"

The base exception for all Griffe errors.

LastNodeError ¤


          flowchart TD
          griffe.exceptions.LastNodeError[LastNodeError]
          griffe.exceptions.GriffeError[GriffeError]

                        griffe.exceptions.GriffeError --> griffe.exceptions.LastNodeError
              


          click griffe.exceptions.LastNodeError href "" "griffe.exceptions.LastNodeError"
          click griffe.exceptions.GriffeError href "" "griffe.exceptions.GriffeError"

Exception raised when trying to access a next or previous node.

LoadingError ¤


          flowchart TD
          griffe.exceptions.LoadingError[LoadingError]
          griffe.exceptions.GriffeError[GriffeError]

                        griffe.exceptions.GriffeError --> griffe.exceptions.LoadingError
              


          click griffe.exceptions.LoadingError href "" "griffe.exceptions.LoadingError"
          click griffe.exceptions.GriffeError href "" "griffe.exceptions.GriffeError"

The base exception for all Griffe errors.

NameResolutionError ¤


          flowchart TD
          griffe.exceptions.NameResolutionError[NameResolutionError]
          griffe.exceptions.GriffeError[GriffeError]

                        griffe.exceptions.GriffeError --> griffe.exceptions.NameResolutionError
              


          click griffe.exceptions.NameResolutionError href "" "griffe.exceptions.NameResolutionError"
          click griffe.exceptions.GriffeError href "" "griffe.exceptions.GriffeError"

Exception for names that cannot be resolved in a object scope.

RootNodeError ¤


          flowchart TD
          griffe.exceptions.RootNodeError[RootNodeError]
          griffe.exceptions.GriffeError[GriffeError]

                        griffe.exceptions.GriffeError --> griffe.exceptions.RootNodeError
              


          click griffe.exceptions.RootNodeError href "" "griffe.exceptions.RootNodeError"
          click griffe.exceptions.GriffeError href "" "griffe.exceptions.GriffeError"

Exception raised when trying to use siblings properties on a root node.

UnhandledEditableModuleError ¤


          flowchart TD
          griffe.exceptions.UnhandledEditableModuleError[UnhandledEditableModuleError]
          griffe.exceptions.GriffeError[GriffeError]

                        griffe.exceptions.GriffeError --> griffe.exceptions.UnhandledEditableModuleError
              


          click griffe.exceptions.UnhandledEditableModuleError href "" "griffe.exceptions.UnhandledEditableModuleError"
          click griffe.exceptions.GriffeError href "" "griffe.exceptions.GriffeError"

Exception for unhandled editables modules, when searching modules.

UnimportableModuleError ¤


          flowchart TD
          griffe.exceptions.UnimportableModuleError[UnimportableModuleError]
          griffe.exceptions.GriffeError[GriffeError]

                        griffe.exceptions.GriffeError --> griffe.exceptions.UnimportableModuleError
              


          click griffe.exceptions.UnimportableModuleError href "" "griffe.exceptions.UnimportableModuleError"
          click griffe.exceptions.GriffeError href "" "griffe.exceptions.GriffeError"

Exception for modules that cannot be imported.