Models¤

Bases: str, Enum

              flowchart TD
              griffe.Kind[Kind]

              

              click griffe.Kind href "" "griffe.Kind"
            

Enumeration of the different object kinds.

Attributes:

• ALIAS –

  Aliases (imported objects).

• ATTRIBUTE –

  Attributes and properties.

• CLASS –

  Classes.

• FUNCTION –

  Functions and methods.

• MODULE –

  Modules.

• TYPE_ALIAS –

  Type aliases.

ALIAS = 'alias'

ATTRIBUTE = 'attribute'

CLASS = 'class'

FUNCTION = 'function'

MODULE = 'module'

TYPE_ALIAS = 'type alias'

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 [].

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

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

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

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

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 [].

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

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

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

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

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 [].

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

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

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

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

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.

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

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

Bases: GetMembersMixin, SetMembersMixin, DelMembersMixin, SerializationMixin

              flowchart TD
              griffe.ObjectAliasMixin[ObjectAliasMixin]
              griffe._internal.mixins.GetMembersMixin[GetMembersMixin]
              griffe._internal.mixins.SetMembersMixin[SetMembersMixin]
              griffe._internal.mixins.DelMembersMixin[DelMembersMixin]
              griffe._internal.mixins.SerializationMixin[SerializationMixin]

                              griffe._internal.mixins.GetMembersMixin --> griffe.ObjectAliasMixin
                
                griffe._internal.mixins.SetMembersMixin --> griffe.ObjectAliasMixin
                
                griffe._internal.mixins.DelMembersMixin --> griffe.ObjectAliasMixin
                
                griffe._internal.mixins.SerializationMixin --> griffe.ObjectAliasMixin
                


              click griffe.ObjectAliasMixin href "" "griffe.ObjectAliasMixin"
              click griffe._internal.mixins.GetMembersMixin href "" "griffe._internal.mixins.GetMembersMixin"
              click griffe._internal.mixins.SetMembersMixin href "" "griffe._internal.mixins.SetMembersMixin"
              click griffe._internal.mixins.DelMembersMixin href "" "griffe._internal.mixins.DelMembersMixin"
              click griffe._internal.mixins.SerializationMixin href "" "griffe._internal.mixins.SerializationMixin"
            

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

Attributes:

• all_members (dict[str, Object | Alias]) –

  All members (declared and inherited).

• modules (dict[str, Module]) –

  The module members.

• classes (dict[str, Class]) –

  The class members.

• functions (dict[str, Function]) –

  The function members.

• attributes (dict[str, Attribute]) –

  The attribute members.

• type_aliases (dict[str, TypeAlias]) –

  The type alias members.

• is_private (bool) –

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

• is_class_private (bool) –

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

• is_special (bool) –

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

• is_imported (bool) –

  Whether this object/alias was imported from another module.

• is_exported (bool) –

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

• is_wildcard_exposed (bool) –

  Whether this object/alias is exposed to wildcard imports.

• is_public (bool) –

  Whether this object is considered public.

• is_deprecated (bool) –

  Whether this object is deprecated.

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: dict[str, Object | Alias]

attributes: dict[str, Attribute]

classes: dict[str, Class]

functions: dict[str, Function]

is_class_private: bool

is_deprecated: bool

is_exported: bool

is_generic: bool

is_imported: bool

is_private: bool

is_public: bool

is_special: bool

is_wildcard_exposed: bool

modules: dict[str, Module]

type_aliases: dict[str, TypeAlias]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Bases: ObjectAliasMixin

              flowchart TD
              griffe.Object[Object]
              griffe._internal.mixins.ObjectAliasMixin[ObjectAliasMixin]
              griffe._internal.mixins.GetMembersMixin[GetMembersMixin]
              griffe._internal.mixins.SetMembersMixin[SetMembersMixin]
              griffe._internal.mixins.DelMembersMixin[DelMembersMixin]
              griffe._internal.mixins.SerializationMixin[SerializationMixin]

                              griffe._internal.mixins.ObjectAliasMixin --> griffe.Object
                                griffe._internal.mixins.GetMembersMixin --> griffe._internal.mixins.ObjectAliasMixin
                
                griffe._internal.mixins.SetMembersMixin --> griffe._internal.mixins.ObjectAliasMixin
                
                griffe._internal.mixins.DelMembersMixin --> griffe._internal.mixins.ObjectAliasMixin
                
                griffe._internal.mixins.SerializationMixin --> griffe._internal.mixins.ObjectAliasMixin
                



              click griffe.Object href "" "griffe.Object"
              click griffe._internal.mixins.ObjectAliasMixin href "" "griffe._internal.mixins.ObjectAliasMixin"
              click griffe._internal.mixins.GetMembersMixin href "" "griffe._internal.mixins.GetMembersMixin"
              click griffe._internal.mixins.SetMembersMixin href "" "griffe._internal.mixins.SetMembersMixin"
              click griffe._internal.mixins.DelMembersMixin href "" "griffe._internal.mixins.DelMembersMixin"
              click griffe._internal.mixins.SerializationMixin href "" "griffe._internal.mixins.SerializationMixin"
            

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.

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 (dict[str, Alias]) –

  The aliases pointing to this object.

• all_members (dict[str, Object | Alias]) –

  All members (declared and inherited).

• attributes (dict[str, Attribute]) –

  The attribute members.

• canonical_path (str) –

  The full dotted path of this object.

• classes (dict[str, Class]) –

  The class members.

• deprecated (bool | str | None) –

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

• docstring (Docstring | None) –

  The object docstring.

• endlineno (int | None) –

  The ending line number of the object.

• exports (list[str | ExprName] | None) –

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

• extra (dict[str, dict[str, Any]]) –

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

• filepath (Path | list[Path]) –

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

• functions (dict[str, Function]) –

  The function members.

• has_docstring (bool) –

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

• has_docstrings (bool) –

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

• imports (dict[str, str]) –

  The other objects imported by this object.

• inherited (bool) –

  Always false for objects.

• inherited_members (dict[str, Alias]) –

  Members that are inherited from base classes.

• is_alias (bool) –

  Always false for objects.

• is_attribute (bool) –

  Whether this object is an attribute.

• is_class (bool) –

  Whether this object is a class.

• is_class_private (bool) –

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

• is_collection (bool) –

  Always false for objects.

• is_deprecated (bool) –

  Whether this object is deprecated.

• is_exported (bool) –

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

• is_function (bool) –

  Whether this object is a function.

• is_generic (bool) –

  Whether this object is generic.

• is_imported (bool) –

  Whether this object/alias was imported from another module.

• is_init_method (bool) –

  Whether this function is an __init__ method.

• is_init_module (bool) –

  Whether this object is an __init__.py module.

• is_module (bool) –

  Whether this object is a module.

• is_namespace_package (bool) –

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

• is_namespace_subpackage (bool) –

  Whether this object is a namespace subpackage.

• is_package (bool) –

  Whether this object is a package (top module).

• is_private (bool) –

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

• is_public (bool) –

  Whether this object is considered public.

• is_special (bool) –

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

• is_subpackage (bool) –

  Whether this object is a subpackage.

• is_type_alias (bool) –

  Whether this object is a type alias.

• is_wildcard_exposed (bool) –

  Whether this object/alias is exposed to wildcard imports.

• kind (Kind) –

  The object kind.

• labels (set[str]) –

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

• lineno (int | None) –

  The starting line number of the object.

• lines (list[str]) –

  The lines containing the source of this object.

• lines_collection (LinesCollection) –

  The lines collection attached to this object or its parents.

• members (dict[str, Object | Alias]) –

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

• module (Module) –

  The parent module of this object.

• modules (dict[str, Module]) –

  The module members.

• modules_collection (ModulesCollection) –

  The modules collection attached to this object or its parents.

• name (str) –

  The object name.

• package (Module) –

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

• parent (Module | Class | None) –

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

• path (str) –

  The dotted path of this object.

• public (bool | None) –

  Whether this object is public.

• relative_filepath (Path) –

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

• relative_package_filepath (Path) –

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

• runtime (bool) –

  Whether this object is available at runtime.

• source (str) –

  The source code of this object.

• type_aliases (dict[str, TypeAlias]) –

  The type alias members.

• type_parameters (TypeParameters) –

  The object type parameters.

aliases: dict[str, Alias] = {}

all_members: dict[str, Object | Alias]

attributes: dict[str, Attribute]

canonical_path: str

classes: dict[str, Class]

deprecated: bool | str | None = None

docstring: Docstring | None = docstring

endlineno: int | None = endlineno

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

from .submodule import __all__ as submodule_all

__all__ = ["hello", *submodule_all]

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

filepath: Path | list[Path]

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

functions: dict[str, Function]

has_docstring: bool

has_docstrings: bool

imports: dict[str, str] = {}

inherited: bool = False

inherited_members: dict[str, Alias]

is_alias: bool = False

is_attribute: bool

is_class: bool

is_class_private: bool

is_collection: bool = False

is_deprecated: bool

is_exported: bool

is_function: bool

is_generic: bool

is_imported: bool

is_init_method: bool

is_init_module: bool

is_module: bool

is_namespace_package: bool

is_namespace_subpackage: bool

is_package: bool

is_private: bool

is_public: bool

is_special: bool

is_subpackage: bool

is_type_alias: bool

is_wildcard_exposed: bool

kind: Kind

labels: set[str] = set()

lineno: int | None = lineno

lines: list[str]

lines_collection: LinesCollection

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