Skip to content

Models¤

Griffe stores information extracted from Python source code into data models.

These models represent trees of objects, starting with modules, and containing classes, functions, attributes, and type aliases.

Modules can have submodules, classes, functions, attributes, and type aliases. Classes can have nested classes, methods, attributes, and type aliases. Functions and attributes do not have any members.

Indirections to objects declared in other modules are represented as "aliases". An alias therefore represents an imported object, and behaves almost exactly like the object it points to: it is a light wrapper around the object, with special methods and properties that allow to access the target's data transparently.

The 6 models:

Model kind enumeration¤

Kind ¤

Bases: str, Enum

Enumeration of the different object kinds.

Referenced by: Returned by:

Attributes:

ALIAS class-attribute instance-attribute ¤

ALIAS = 'alias'

Aliases (imported objects).

Referenced by:

ATTRIBUTE class-attribute instance-attribute ¤

ATTRIBUTE = 'attribute'

Attributes and properties.

CLASS class-attribute instance-attribute ¤

CLASS = 'class'

Classes.

FUNCTION class-attribute instance-attribute ¤

FUNCTION = 'function'

Functions and methods.

MODULE class-attribute instance-attribute ¤

MODULE = 'module'

Modules.

TYPE_ALIAS class-attribute instance-attribute ¤

TYPE_ALIAS = 'type alias'

Type aliases.

Models base classes¤

GetMembersMixin ¤

Mixin class to share methods for accessing members.

Methods:

  • get_member –

    Get a member with its name or path.

  • __getitem__ –

    Same as get_member, with the item syntax [].

Subclassed by:

__getitem__ ¤

__getitem__(key: str | Sequence[str]) -> Any

Get a member with its name or path.

This method is part of the consumer API: do not use when producing Griffe trees!

Members will be looked up in both declared members and inherited ones, triggering computation of the latter.

Parameters:

Examples:

>>> foo = griffe_object["foo"]
>>> bar = griffe_object["path.to.bar"]
>>> qux = griffe_object[("path", "to", "qux")]

get_member ¤

get_member(key: str | Sequence[str]) -> Any

Get a member with its name or path.

This method is part of the producer API: you can use it safely while building Griffe trees (for example in Griffe extensions).

Members will be looked up in declared members only, not inherited ones.

Parameters:

Examples:

>>> foo = griffe_object["foo"]
>>> bar = griffe_object["path.to.bar"]
>>> bar = griffe_object[("path", "to", "bar")]
Referenced by:

SetMembersMixin ¤

Mixin class to share methods for setting members.

Methods:

  • set_member –

    Set a member with its name or path.

  • __setitem__ –

    Same as set_member, with the item syntax [].

Subclassed by:

__setitem__ ¤

__setitem__(
    key: str | Sequence[str], value: Object | Alias
) -> None

Set a member with its name or path.

This method is part of the consumer API: do not use when producing Griffe trees!

Parameters:

Examples:

>>> griffe_object["foo"] = foo
>>> griffe_object["path.to.bar"] = bar
>>> griffe_object[("path", "to", "qux")] = qux

set_member ¤

set_member(
    key: str | Sequence[str], value: Object | Alias
) -> None

Set a member with its name or path.

This method is part of the producer API: you can use it safely while building Griffe trees (for example in Griffe extensions).

Parameters:

Examples:

>>> griffe_object.set_member("foo", foo)
>>> griffe_object.set_member("path.to.bar", bar)
>>> griffe_object.set_member(("path", "to", "qux"), qux)
Referenced by:

DelMembersMixin ¤

Mixin class to share methods for deleting members.

Methods:

  • del_member –

    Delete a member with its name or path.

  • __delitem__ –

    Same as del_member, with the item syntax [].

Subclassed by:

__delitem__ ¤

__delitem__(key: str | Sequence[str]) -> None

Delete a member with its name or path.

This method is part of the consumer API: do not use when producing Griffe trees!

Members will be looked up in both declared members and inherited ones, triggering computation of the latter.

Parameters:

Examples:

>>> del griffe_object["foo"]
>>> del griffe_object["path.to.bar"]
>>> del griffe_object[("path", "to", "qux")]

del_member ¤

del_member(key: str | Sequence[str]) -> None

Delete a member with its name or path.

This method is part of the producer API: you can use it safely while building Griffe trees (for example in Griffe extensions).

Members will be looked up in declared members only, not inherited ones.

Parameters:

Examples:

>>> griffe_object.del_member("foo")
>>> griffe_object.del_member("path.to.bar")
>>> griffe_object.del_member(("path", "to", "qux"))

SerializationMixin ¤

Mixin class to share methods for de/serializing objects.

Methods:

  • as_json –

    Return this object's data as a JSON string.

  • from_json –

    Create an instance of this class from a JSON string.

Subclassed by:

as_json ¤

as_json(*, full: bool = False, **kwargs: Any) -> str

Return this object's data as a JSON string.

Parameters:

  • full ¤

    (bool, default: False ) –

    Whether to return full info, or just base info.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional serialization options passed to encoder.

Returns:

  • str –

    A JSON string.

Referenced by:

from_json classmethod ¤

from_json(json_string: str, **kwargs: Any) -> _ObjType

Create an instance of this class from a JSON string.

Parameters:

  • json_string ¤

    (str) –

    JSON to decode into Object.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional options passed to decoder.

Returns:

  • _ObjType –

    An Object instance.

Raises:

  • TypeError –

    When the json_string does not represent and object of the class from which this classmethod has been called.

Referenced by:

ObjectAliasMixin ¤

Bases: GetMembersMixin, SetMembersMixin, DelMembersMixin, SerializationMixin

Mixin class to share methods that appear both in objects and aliases, unchanged.

Attributes:

Subclassed by:

Methods:

  • __delitem__ –

    Delete a member with its name or path.

  • __getitem__ –

    Get a member with its name or path.

  • __setitem__ –

    Set a member with its name or path.

  • as_json –

    Return this object's data as a JSON string.

  • del_member –

    Delete a member with its name or path.

  • from_json –

    Create an instance of this class from a JSON string.

  • get_member –

    Get a member with its name or path.

  • set_member –

    Set a member with its name or path.

all_members property ¤

all_members: dict[str, Object | Alias]

All members (declared and inherited).

This method is part of the consumer API: do not use when producing Griffe trees!

Referenced by:

attributes property ¤

attributes: dict[str, Attribute]

The attribute members.

This method is part of the consumer API: do not use when producing Griffe trees!

Referenced by:

classes property ¤

classes: dict[str, Class]

The class members.

This method is part of the consumer API: do not use when producing Griffe trees!

Referenced by:

functions property ¤

functions: dict[str, Function]

The function members.

This method is part of the consumer API: do not use when producing Griffe trees!

Referenced by:

is_class_private property ¤

is_class_private: bool

Whether this object/alias is class-private (starts with __ and is a class member).

Referenced by:

is_deprecated property ¤

is_deprecated: bool

Whether this object is deprecated.

Referenced by:

is_exported property ¤

is_exported: bool

Whether this object/alias is exported (listed in __all__).

Referenced by:

is_generic property ¤

is_generic: bool

Whether this object is generic.

is_imported property ¤

is_imported: bool

Whether this object/alias was imported from another module.

Referenced by:

is_private property ¤

is_private: bool

Whether this object/alias is private (starts with _) but not special.

Referenced by:

is_public property ¤

is_public: bool

Whether this object is considered public.

In modules, developers can mark objects as public thanks to the __all__ variable. In classes however, there is no convention or standard to do so.

Therefore, to decide whether an object is public, we follow this algorithm:

  • If the object's public attribute is set (boolean), return its value.
  • If the object is listed in its parent's (a module) __all__ attribute, it is public.
  • If the parent (module) defines __all__ and the object is not listed in, it is private.
  • If the object has a private name, it is private.
  • If the object was imported from another module, it is private.
  • Otherwise, the object is public.
Referenced by:

is_special property ¤

is_special: bool

Whether this object/alias is special ("dunder" attribute/method, starts and end with __).

Referenced by:

is_wildcard_exposed property ¤

is_wildcard_exposed: bool

Whether this object/alias is exposed to wildcard imports.

To be exposed to wildcard imports, an object/alias must:

  • be available at runtime
  • have a module as parent
  • be listed in __all__ if __all__ is defined
  • or not be private (having a name starting with an underscore)

Special case for Griffe trees: a submodule is only exposed if its parent imports it.

Returns:

  • bool –

    True or False.

Referenced by:

modules property ¤

modules: dict[str, Module]

The module members.

This method is part of the consumer API: do not use when producing Griffe trees!

Referenced by:

type_aliases property ¤

type_aliases: dict[str, TypeAlias]

The type alias members.

This method is part of the consumer API: do not use when producing Griffe trees!

Referenced by:

__delitem__ ¤

__delitem__(key: str | Sequence[str]) -> None

Delete a member with its name or path.

This method is part of the consumer API: do not use when producing Griffe trees!

Members will be looked up in both declared members and inherited ones, triggering computation of the latter.

Parameters:

Examples:

>>> del griffe_object["foo"]
>>> del griffe_object["path.to.bar"]
>>> del griffe_object[("path", "to", "qux")]

__getitem__ ¤

__getitem__(key: str | Sequence[str]) -> Any

Get a member with its name or path.

This method is part of the consumer API: do not use when producing Griffe trees!

Members will be looked up in both declared members and inherited ones, triggering computation of the latter.

Parameters:

Examples:

>>> foo = griffe_object["foo"]
>>> bar = griffe_object["path.to.bar"]
>>> qux = griffe_object[("path", "to", "qux")]

__setitem__ ¤

__setitem__(
    key: str | Sequence[str], value: Object | Alias
) -> None

Set a member with its name or path.

This method is part of the consumer API: do not use when producing Griffe trees!

Parameters:

Examples:

>>> griffe_object["foo"] = foo
>>> griffe_object["path.to.bar"] = bar
>>> griffe_object[("path", "to", "qux")] = qux

as_json ¤

as_json(*, full: bool = False, **kwargs: Any) -> str

Return this object's data as a JSON string.

Parameters:

  • full ¤

    (bool, default: False ) –

    Whether to return full info, or just base info.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional serialization options passed to encoder.

Returns:

  • str –

    A JSON string.

Referenced by:

del_member ¤

del_member(key: str | Sequence[str]) -> None

Delete a member with its name or path.

This method is part of the producer API: you can use it safely while building Griffe trees (for example in Griffe extensions).

Members will be looked up in declared members only, not inherited ones.

Parameters:

Examples:

>>> griffe_object.del_member("foo")
>>> griffe_object.del_member("path.to.bar")
>>> griffe_object.del_member(("path", "to", "qux"))

from_json classmethod ¤

from_json(json_string: str, **kwargs: Any) -> _ObjType

Create an instance of this class from a JSON string.

Parameters:

  • json_string ¤

    (str) –

    JSON to decode into Object.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional options passed to decoder.

Returns:

  • _ObjType –

    An Object instance.

Raises:

  • TypeError –

    When the json_string does not represent and object of the class from which this classmethod has been called.

Referenced by:

get_member ¤

get_member(key: str | Sequence[str]) -> Any

Get a member with its name or path.

This method is part of the producer API: you can use it safely while building Griffe trees (for example in Griffe extensions).

Members will be looked up in declared members only, not inherited ones.

Parameters:

Examples:

>>> foo = griffe_object["foo"]
>>> bar = griffe_object["path.to.bar"]
>>> bar = griffe_object[("path", "to", "bar")]
Referenced by:

set_member ¤

set_member(
    key: str | Sequence[str], value: Object | Alias
) -> None

Set a member with its name or path.

This method is part of the producer API: you can use it safely while building Griffe trees (for example in Griffe extensions).

Parameters:

Examples:

>>> griffe_object.set_member("foo", foo)
>>> griffe_object.set_member("path.to.bar", bar)
>>> griffe_object.set_member(("path", "to", "qux"), qux)
Referenced by:

Object ¤

Object(
    name: str,
    *,
    lineno: int | None = None,
    endlineno: int | None = None,
    runtime: bool = True,
    docstring: Docstring | None = None,
    type_parameters: TypeParameters | None = None,
    parent: Module | Class | None = None,
    lines_collection: LinesCollection | None = None,
    modules_collection: ModulesCollection | None = None,
)

Bases: ObjectAliasMixin

An abstract class representing a Python object.

Parameters:

  • name ¤

    (str) –

    The object name, as declared in the code.

  • lineno ¤

    (int | None, default: None ) –

    The object starting line, or None for modules. Lines start at 1.

  • endlineno ¤

    (int | None, default: None ) –

    The object ending line (inclusive), or None for modules.

  • runtime ¤

    (bool, default: True ) –

    Whether this object is present at runtime or not.

  • docstring ¤

    (Docstring | None, default: None ) –

    The object docstring.

  • type_parameters ¤

    (TypeParameters | None, default: None ) –

    The object type parameters, if any.

  • parent ¤

    (Module | Class | None, default: None ) –

    The object parent.

  • lines_collection ¤

    (LinesCollection | None, default: None ) –

    A collection of source code lines.

  • modules_collection ¤

    (ModulesCollection | None, default: None ) –

    A collection of modules.

Referenced by: Returned by: Subclassed by: Used by:

Methods:

  • __bool__ –

    An object is always true-ish.

  • __delitem__ –

    Delete a member with its name or path.

  • __getitem__ –

    Get a member with its name or path.

  • __len__ –

    The number of members in this object, recursively.

  • __setitem__ –

    Set a member with its name or path.

  • as_dict –

    Return this object's data as a dictionary.

  • as_json –

    Return this object's data as a JSON string.

  • del_member –

    Delete a member with its name or path.

  • filter_members –

    Filter and return members based on predicates.

  • from_json –

    Create an instance of this class from a JSON string.

  • get_member –

    Get a member with its name or path.

  • has_labels –

    Tell if this object has all the given labels.

  • is_kind –

    Tell if this object is of the given kind.

  • resolve –

    Resolve a name within this object's and parents' scope.

  • set_member –

    Set a member with its name or path.

Attributes:

aliases instance-attribute ¤

aliases: dict[str, Alias] = {}

The aliases pointing to this object.

Referenced by:

all_members property ¤

all_members: dict[str, Object | Alias]

All members (declared and inherited).

This method is part of the consumer API: do not use when producing Griffe trees!

Referenced by:

attributes property ¤

attributes: dict[str, Attribute]

The attribute members.

This method is part of the consumer API: do not use when producing Griffe trees!

Referenced by:

canonical_path property ¤

canonical_path: str

The full dotted path of this object.

The canonical path is the path where the object was defined (not imported).

See also: path.

Referenced by:

classes property ¤

classes: dict[str, Class]

The class members.

This method is part of the consumer API: do not use when producing Griffe trees!

Referenced by:

deprecated instance-attribute ¤

deprecated: bool | str | None = None

Whether this object is deprecated (boolean or deprecation message).

Referenced by:

docstring instance-attribute ¤

docstring: Docstring | None = docstring

The object docstring.

See also: has_docstring, has_docstrings.

Referenced by:

endlineno instance-attribute ¤

endlineno: int | None = endlineno

The ending line number of the object.

See also: lineno.

Referenced by:

exports instance-attribute ¤

exports: list[str | ExprName] | None = None

The names of the objects exported by this (module) object through the __all__ variable.

Exports can contain string (object names) or resolvable names, like other lists of exports coming from submodules:

from .submodule import __all__ as submodule_all

__all__ = ["hello", *submodule_all]

Exports get expanded by the loader before it expands wildcards and resolves aliases.

See also: GriffeLoader.expand_exports.

Referenced by:

extra instance-attribute ¤

extra: dict[str, dict[str, Any]] = defaultdict(dict)

Namespaced dictionaries storing extra metadata for this object, used by extensions.

filepath property ¤

filepath: Path | list[Path]

The file path (or directory list for namespace packages) where this object was defined.

See also: relative_filepath, relative_package_filepath.

Examples:

>>> import griffe
>>> markdown = griffe.load("markdown")
>>> markdown.filepath
PosixPath('~/project/.venv/lib/python3.11/site-packages/markdown/__init__.py')
Referenced by:

functions property ¤

functions: dict[str, Function]

The function members.

This method is part of the consumer API: do not use when producing Griffe trees!

Referenced by:

has_docstring property ¤

has_docstring: bool

Whether this object has a docstring (empty or not).

See also: docstring, has_docstrings.

Referenced by:

has_docstrings property ¤

has_docstrings: bool

Whether this object or any of its members has a docstring (empty or not).

Inherited members are not considered. Imported members are not considered, unless they are also public.

See also: docstring, has_docstring.

Referenced by:

imports instance-attribute ¤

imports: dict[str, str] = {}

The other objects imported by this object.

Keys are the names within the object (from ... import ... as AS_NAME), while the values are the actual names of the objects (from ... import REAL_NAME as ...).

Referenced by:

inherited class-attribute instance-attribute ¤

inherited: bool = False

Always false for objects.

Only aliases can be marked as inherited.

inherited_members property ¤

inherited_members: dict[str, Alias]

Members that are inherited from base classes.

This method is part of the consumer API: do not use when producing Griffe trees!

See also: members.

Referenced by:

is_alias class-attribute instance-attribute ¤

is_alias: bool = False

Always false for objects.

Referenced by:

is_attribute property ¤

is_attribute: bool

Whether this object is an attribute.

See also: is_module. is_class, is_function, is_type_alias, is_alias, is_kind.

Referenced by:

is_class property ¤

is_class: bool

Whether this object is a class.

See also: is_module. is_function, is_attribute, is_type_alias, is_alias, is_kind.

Referenced by:

is_class_private property ¤

is_class_private: bool

Whether this object/alias is class-private (starts with __ and is a class member).

Referenced by:

is_collection class-attribute instance-attribute ¤

is_collection: bool = False

Always false for objects.

is_deprecated property ¤

is_deprecated: bool

Whether this object is deprecated.

Referenced by:

is_exported property ¤

is_exported: bool

Whether this object/alias is exported (listed in __all__).

Referenced by:

is_function property ¤

is_function: bool

Whether this object is a function.

See also: is_module. is_class, is_attribute, is_type_alias, is_alias, is_kind.

Referenced by:

is_generic property ¤

is_generic: bool

Whether this object is generic.

is_imported property ¤

is_imported: bool

Whether this object/alias was imported from another module.

Referenced by:

is_init_module property ¤

is_init_module: bool

Whether this object is an __init__.py module.

See also: is_module.

Referenced by:

is_module property ¤

is_module: bool

Whether this object is a module.

See also: is_init_module. is_class, is_function, is_attribute, is_type_alias, is_alias, is_kind.

Referenced by:

is_namespace_package property ¤

is_namespace_package: bool

Whether this object is a namespace package (top folder, no __init__.py).

See also: is_namespace_subpackage.

Referenced by:

is_namespace_subpackage property ¤

is_namespace_subpackage: bool

Whether this object is a namespace subpackage.

See also: is_namespace_package.

Referenced by:

is_package property ¤

is_package: bool

Whether this object is a package (top module).

See also: is_subpackage.

Referenced by:

is_private property ¤

is_private: bool

Whether this object/alias is private (starts with _) but not special.

Referenced by:

is_public property ¤

is_public: bool

Whether this object is considered public.

In modules, developers can mark objects as public thanks to the __all__ variable. In classes however, there is no convention or standard to do so.

Therefore, to decide whether an object is public, we follow this algorithm:

  • If the object's public attribute is set (boolean), return its value.
  • If the object is listed in its parent's (a module) __all__ attribute, it is public.
  • If the parent (module) defines __all__ and the object is not listed in, it is private.
  • If the object has a private name, it is private.
  • If the object was imported from another module, it is private.
  • Otherwise, the object is public.
Referenced by:

is_special property ¤

is_special: bool

Whether this object/alias is special ("dunder" attribute/method, starts and end with __).

Referenced by:

is_subpackage property ¤

is_subpackage: bool

Whether this object is a subpackage.

See also: is_package.

Referenced by:

is_type_alias property ¤

is_type_alias: bool

Whether this object is a type alias.

See also: is_module. is_class, is_function, is_attribute, is_alias, is_kind.

Referenced by:

is_wildcard_exposed property ¤

is_wildcard_exposed: bool

Whether this object/alias is exposed to wildcard imports.

To be exposed to wildcard imports, an object/alias must:

  • be available at runtime
  • have a module as parent
  • be listed in __all__ if __all__ is defined
  • or not be private (having a name starting with an underscore)

Special case for Griffe trees: a submodule is only exposed if its parent imports it.

Returns:

  • bool –

    True or False.

Referenced by:

kind instance-attribute ¤

kind: Kind

The object kind.

Referenced by:

labels instance-attribute ¤

labels: set[str] = set()

The object labels (property, dataclass, etc.).

See also: has_labels.

Referenced by:

lineno instance-attribute ¤

lineno: int | None = lineno

The starting line number of the object.

See also: endlineno.

Referenced by:

lines property ¤

lines: list[str]

The lines containing the source of this object.

See also: lines_collection, source.

Referenced by:

lines_collection property ¤

lines_collection: LinesCollection

The lines collection attached to this object or its parents.

See also: lines, source.

Raises:

  • ValueError –

    When no modules collection can be found in the object or its parents.

Referenced by:

members instance-attribute ¤

members: dict[str, Object | Alias] = {}

The object members (modules, classes, functions, attributes, type aliases).

See also: inherited_members, get_member, set_member, filter_members.

Referenced by:

module property ¤

module: Module

The parent module of this object.

See also: package.

Examples:

>>> import griffe
>>> markdown = griffe.load("markdown")
>>> markdown["core.Markdown.references"].module
Module(PosixPath('~/project/.venv/lib/python3.11/site-packages/markdown/core.py'))
>>> # The `module` of a module is itself.
>>> markdown["core"].module
Module(PosixPath('~/project/.venv/lib/python3.11/site-packages/markdown/core.py'))

Raises:

  • ValueError –

    When the object is not a module and does not have a parent.

Referenced by:

modules property ¤

modules: dict[str, Module]

The module members.

This method is part of the consumer API: do not use when producing Griffe trees!

Referenced by:

modules_collection property ¤

modules_collection: ModulesCollection

The modules collection attached to this object or its parents.

Raises:

  • ValueError –

    When no modules collection can be found in the object or its parents.

Referenced by:

name instance-attribute ¤

name: str = name

The object name.

package property ¤

package: Module

The absolute top module (the package) of this object.

See also: module.

Examples:

>>> import griffe
>>> markdown = griffe.load("markdown")
>>> markdown["core.Markdown.references"].package
Module(PosixPath('~/project/.venv/lib/python3.11/site-packages/markdown/__init__.py'))
Referenced by:

parent instance-attribute ¤

parent: Module | Class | None = parent

The parent of the object (none if top module).

Referenced by:

path property ¤

path: str

The dotted path of this object.

On regular objects (not aliases), the path is the canonical path.

See also: canonical_path.

Examples:

>>> import griffe
>>> markdown = griffe.load("markdown")
>>> markdown["core.Markdown.references"].path
'markdown.core.Markdown.references'
Referenced by:

public instance-attribute ¤

public: bool | None = None

Whether this object is public.

Referenced by:

relative_filepath property ¤

relative_filepath: Path

The file path where this object was defined, relative to the current working directory.

If this object's file path is not relative to the current working directory, return its absolute path.

See also: filepath, relative_package_filepath.

Raises:

  • ValueError –

    When the relative path could not be computed.

Referenced by:

relative_package_filepath property ¤

relative_package_filepath: Path

The file path where this object was defined, relative to the top module path.

See also: filepath, relative_filepath.

Raises:

  • ValueError –

    When the relative path could not be computed.

Referenced by:

runtime instance-attribute ¤

runtime: bool = runtime

Whether this object is available at runtime.

Typically, type-guarded objects (under an if TYPE_CHECKING condition) are not available at runtime.

source property ¤

source: str

The source code of this object.

See also: lines, lines_collection.

Referenced by:

type_aliases property ¤

type_aliases: dict[str, TypeAlias]

The type alias members.

This method is part of the consumer API: do not use when producing Griffe trees!

Referenced by:

type_parameters instance-attribute ¤

type_parameters: TypeParameters = (
    type_parameters or TypeParameters()
)

The object type parameters.

Referenced by:

__bool__ ¤

__bool__() -> bool

An object is always true-ish.

__delitem__ ¤

__delitem__(key: str | Sequence[str]) -> None

Delete a member with its name or path.

This method is part of the consumer API: do not use when producing Griffe trees!

Members will be looked up in both declared members and inherited ones, triggering computation of the latter.

Parameters:

Examples:

>>> del griffe_object["foo"]
>>> del griffe_object["path.to.bar"]
>>> del griffe_object[("path", "to", "qux")]

__getitem__ ¤

__getitem__(key: str | Sequence[str]) -> Any

Get a member with its name or path.

This method is part of the consumer API: do not use when producing Griffe trees!

Members will be looked up in both declared members and inherited ones, triggering computation of the latter.

Parameters:

Examples:

>>> foo = griffe_object["foo"]
>>> bar = griffe_object["path.to.bar"]
>>> qux = griffe_object[("path", "to", "qux")]

__len__ ¤

__len__() -> int

The number of members in this object, recursively.

__setitem__ ¤

__setitem__(
    key: str | Sequence[str], value: Object | Alias
) -> None

Set a member with its name or path.

This method is part of the consumer API: do not use when producing Griffe trees!

Parameters:

Examples:

>>> griffe_object["foo"] = foo
>>> griffe_object["path.to.bar"] = bar
>>> griffe_object[("path", "to", "qux")] = qux

as_dict ¤

as_dict(
    *, full: bool = False, **kwargs: Any
) -> dict[str, Any]

Return this object's data as a dictionary.

See also: as_json.

Parameters:

  • full ¤

    (bool, default: False ) –

    Whether to return full info, or just base info.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional serialization options.

Returns:

Referenced by:

as_json ¤

as_json(*, full: bool = False, **kwargs: Any) -> str

Return this object's data as a JSON string.

Parameters:

  • full ¤

    (bool, default: False ) –

    Whether to return full info, or just base info.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional serialization options passed to encoder.

Returns:

  • str –

    A JSON string.

Referenced by:

del_member ¤

del_member(key: str | Sequence[str]) -> None

Delete a member with its name or path.

This method is part of the producer API: you can use it safely while building Griffe trees (for example in Griffe extensions).

Members will be looked up in declared members only, not inherited ones.

Parameters:

Examples:

>>> griffe_object.del_member("foo")
>>> griffe_object.del_member("path.to.bar")
>>> griffe_object.del_member(("path", "to", "qux"))

filter_members ¤

filter_members(
    *predicates: Callable[[Object | Alias], bool],
) -> dict[str, Object | Alias]

Filter and return members based on predicates.

See also: members.

Parameters:

  • *predicates ¤

    (Callable[[Object | Alias], bool], default: () ) –

    A list of predicates, i.e. callables accepting a member as argument and returning a boolean.

Returns:

Referenced by:

from_json classmethod ¤

from_json(json_string: str, **kwargs: Any) -> _ObjType

Create an instance of this class from a JSON string.

Parameters:

  • json_string ¤

    (str) –

    JSON to decode into Object.

  • **kwargs ¤

    (Any, default: {} ) –

    Additional options passed to decoder.

Returns:

  • _ObjType –

    An Object instance.

Raises:

  • TypeError –

    When the json_string does not represent and object of the class from which this classmethod has been called.

Referenced by:

get_member ¤

get_member(key: str | Sequence[str]) -> Any

Get a member with its name or path.

This method is part of the producer API: you can use it safely while building Griffe trees (for example in Griffe extensions).

Members will be looked up in declared members only, not inherited ones.

Parameters:

Examples:

>>> foo = griffe_object["foo"]
>>> bar = griffe_object["path.to.bar"]
>>> bar = griffe_object[("path", "to", "bar")]
Referenced by:

has_labels ¤

has_labels(*labels: str) -> bool

Tell if this object has all the given labels.

See also: labels.

Parameters:

  • *labels ¤

    (str, default: () ) –

    Labels that must be present.

Returns:

  • bool –

    True or False.

Referenced by:

is_kind ¤

is_kind(kind: str | Kind | set[str | Kind]) -> bool

Tell if this object is of the given kind.

See also: is_module, is_class, is_function, is_attribute, is_type_alias, is_alias.

Parameters:

  • kind ¤

    (str | Kind | set[str | Kind]) –

    An instance or set of kinds (strings or enumerations).

Raises:

  • ValueError –

    When an empty set is given as argument.

Returns:

  • bool –

    True or False.

Referenced by:

resolve ¤

resolve(name: str) -> str

Resolve a name within this object's and parents' scope.

Parameters:

  • name ¤

    (str) –

    The name to resolve.

Raises:

Returns:

  • str –

    The resolved name.

set_member ¤

set_member(
    key: str | Sequence[str], value: Object | Alias
) -> None

Set a member with its name or path.

This method is part of the producer API: you can use it safely while building Griffe trees (for example in Griffe extensions).

Parameters:

Examples:

>>> griffe_object.set_member("foo", foo)
>>> griffe_object.set_member("path.to.bar", bar)
>>> griffe_object.set_member(("path", "to", "qux"), qux)
Referenced by:

Models type parameter¤

TypeParameters ¤

TypeParameters(*type_parameters: TypeParameter)

This class is a container for type parameters.

It allows to get type parameters using their position (index) or their name:

>>> type_parameters = TypeParameters(TypeParameter("hello"), kind=TypeParameterKind.type_var)
>>> type_parameters[0] is type_parameters["hello"]
True

Parameters:

  • *type_parameters ¤

    (TypeParameter, default: () ) –

    The initial type parameters to add to the container.

Referenced by: Returned by:

Methods:

  • __contains__ –

    Whether a type parameter with the given name is present.

  • __delitem__ –

    Delete a type parameter by index or name.

  • __getitem__ –

    Get a type parameter by index or name.

  • __iter__ –

    Iterate over the type parameters, in order.

  • __len__ –

    The number of type parameters.

  • __setitem__ –

    Set a type parameter by index or name.

  • add –

    Add a type parameter to the container.

__contains__ ¤

__contains__(type_param_name: str)

Whether a type parameter with the given name is present.

__delitem__ ¤

__delitem__(name_or_index: int | str) -> None

Delete a type parameter by index or name.

__getitem__ ¤

__getitem__(name_or_index: int | str) -> TypeParameter

Get a type parameter by index or name.

__iter__ ¤

__iter__()

Iterate over the type parameters, in order.

__len__ ¤

__len__()

The number of type parameters.

__setitem__ ¤

__setitem__(
    name_or_index: int | str, type_parameter: TypeParameter
) -> None

Set a type parameter by index or name.

add ¤

add(type_parameter: TypeParameter) -> None

Add a type parameter to the container.

Parameters:

Raises:

  • ValueError –

    When a type parameter with the same name is already present.

TypeParameter ¤

TypeParameter(
    name: str,
    *,
    kind: TypeParameterKind,
    bound: str | Expr | None = None,
    constraints: Sequence[str | Expr] | None = None,
    default: str | Expr | None = None,
)

This class represents a type parameter.

Parameters:

  • name ¤

    (str) –

    The type parameter name, without leading stars (* or **).

  • kind ¤

    (TypeParameterKind) –

    The type parameter kind.

  • bound ¤

    (str | Expr | None, default: None ) –

    The type parameter bound, if any. Mutually exclusive with constraints.

  • constraints ¤

    (Sequence[str | Expr] | None, default: None ) –

    The type parameter constraints, if any. Mutually exclusive with bound.

  • default ¤

    (str | Expr | None, default: None ) –

    The type parameter default, if any.

Raises:

  • ValueError –

    When more than one of bound and constraints is set.

Returned by: Used by:

Methods:

  • as_dict –

    Return this type parameter's data as a dictionary.

Attributes:

annotation instance-attribute ¤

annotation: str | Expr | None

The type parameter bound or constraints.

bound property writable ¤

bound: str | Expr | None

The type parameter bound.

constraints property writable ¤

constraints: tuple[str | Expr, ...] | None

The type parameter constraints.

default instance-attribute ¤

default: str | Expr | None = default

The type parameter default value.

kind instance-attribute ¤

kind: TypeParameterKind = kind

The type parameter kind.

name instance-attribute ¤

name: str = name

The type parameter name.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this type parameter's data as a dictionary.

Parameters:

  • **kwargs ¤

    (Any, default: {} ) –

    Additional serialization options.

Returns:

TypeParameterKind ¤

Bases: str, Enum

Enumeration of the different type parameter kinds.

Returned by: Used by:

Attributes:

param_spec class-attribute instance-attribute ¤

param_spec = 'param-spec'

Parameter specification variable.

type_var class-attribute instance-attribute ¤

type_var = 'type-var'

Type variable.

type_var_tuple class-attribute instance-attribute ¤

type_var_tuple = 'type-var-tuple'

Type variable tuple.

Was this page helpful?