Skip to content

Exceptions¤

GriffeError ¤

Bases: Exception


              flowchart TD
              griffe.GriffeError[GriffeError]

              

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

The base exception for all Griffe errors.

Referenced by: Subclassed by:

LoadingError ¤

Bases: GriffeError


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

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


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

The base exception for all Griffe errors.

Raised by: Referenced by:

NameResolutionError ¤

Bases: GriffeError


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

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


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

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

Raised by: Referenced by:

UnhandledEditableModuleError ¤

Bases: GriffeError


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

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


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

Exception for unhandled editables modules, when searching modules.

Referenced by:

UnimportableModuleError ¤

Bases: GriffeError


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

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


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

Exception for modules that cannot be imported.

Referenced by:

AliasResolutionError ¤

AliasResolutionError(alias: Alias)

Bases: GriffeError


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

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


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

Exception for alias that cannot be resolved.

Parameters:

  • alias ¤

    (Alias) –

    The alias that could not be resolved.

Raised by: Referenced by:

Attributes:

  • alias (Alias) –

    The alias that triggered the error.

Source code in src/griffe/_internal/exceptions.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def __init__(self, alias: Alias) -> None:
    """Initialize the exception.

    Parameters:
        alias: The alias that could not be resolved.
    """
    self.alias: Alias = alias
    """The alias that triggered the error."""

    message = f"Could not resolve alias {alias.path} pointing at {alias.target_path}"
    try:
        filepath = alias.parent.relative_filepath  # type: ignore[union-attr]
    except BuiltinModuleError:
        pass
    else:
        message += f" (in {filepath}:{alias.alias_lineno})"
    super().__init__(message)

alias instance-attribute ¤

alias: Alias = alias

The alias that triggered the error.

CyclicAliasError ¤

CyclicAliasError(chain: list[str])

Bases: GriffeError


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

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


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

Exception raised when a cycle is detected in aliases.

Parameters:

  • chain ¤

    (list[str]) –

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

Raised by: Referenced by:

Attributes:

  • chain (list[str]) –

    The chain of aliases that created the cycle.

Source code in src/griffe/_internal/exceptions.py 
56
57
58
59
60
61
62
63
64
65
def __init__(self, chain: list[str]) -> None:
    """Initialize the exception.

    Parameters:
        chain: The cyclic chain of items (such as target path).
    """
    self.chain: list[str] = chain
    """The chain of aliases that created the cycle."""

    super().__init__("Cyclic aliases detected:\n  " + "\n  ".join(self.chain))

chain instance-attribute ¤

chain: list[str] = chain

The chain of aliases that created the cycle.

LastNodeError ¤

Bases: GriffeError


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

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


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

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

Raised by: Referenced by:

RootNodeError ¤

Bases: GriffeError


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

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


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

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

Referenced by:

BuiltinModuleError ¤

Bases: GriffeError


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

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


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

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

Raised by: Referenced by:

ExtensionError ¤

Bases: GriffeError


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

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


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

Base class for errors raised by extensions.

Referenced by: Subclassed by:

ExtensionNotLoadedError ¤

Bases: ExtensionError


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

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



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

Exception raised when an extension could not be loaded.

Referenced by:

GitError ¤

Bases: GriffeError


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

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


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

Exception raised for errors related to Git.

Referenced by: