The class representing a Python function.

This class represent a function parameter. See also: [`Parameters`][griffe.Parameters].

This class is a container for parameters. It allows to get parameters using their position (index) or their name: ```pycon >>> parameter

The Griffe loader, allowing to load data from modules.

This class represents docstrings.

This class represent a documented function parameter.

The class representing a Python module/class/instance attribute.

This class represents a Python object identified by a name in a given scope.

The class representing a Python module.

The class representing a Python class.

This class is a container for type parameters. It allows to get type parameters using their position (index) or their name: ```pycon >>>

This class represents a type parameter.

This class represents a documented return value.

This class represents an alias, or indirection, to an object declared in another module. Aliases represent objects that are in the scope of a mod

This class represents a documented module/class attribute.

This class represents a documented raise value.

Maps directive names to parser functions.

This class represents a text section.

Tuples like `(0, 1, 2)`.

The Griffe finder, allowing to find modules on the file system. The module finder is generally not used directly. Each [`GriffeLoader`][griff

Exception raised when a cycle is detected in aliases.

This class represents a parameters section.

Binary operations like `a + b`.

Exception raised when an extension could not be loaded.

A simple dictionary containing the modules source code lines.

The base exception for all Griffe errors.

This class represents a returns section.

Attributes like `a.b`.

Subscripts like `a[b]`.

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

A collection of modules, allowing easy access to members.

This class is a simple placeholder used during the process of finding packages. Parameters: name: The package name. path: The pac

This class represents decorators.

This class represents an attributes section.

This class represents a raises section.

Helper class to represent an object tree. It's not really a tree but more a backward-linked list: each node has a reference to its parent, bu

Enumeration of the different docstring parsers.

The class representing a Python type alias.

Specific breakage class for attributes whose value changed.

This class represents a documented class.

This class represents a documented function.

This class represents a documented module.

This class represents a documented receive value.

This class represents an admonition section.

This class represents a classes section.

This class represents an examples section.

This class represents a functions/methods section.

This class represents a modules section.

This class represents an other parameters section.

This class represents a receives section.

This class represents a type aliases section.

This class represents a type parameters section.

This class represents a warns section.

This class represents a yields section.

This class represents a documented type alias.

This class represent a documented type parameter.

This class represents a documented warn value.

This class represents a documented yield value.

Calls like `f()`.

Exception raised for errors related to Git.

This class is used to instantiate an inspector. Inspectors iterate on objects members to extract data from them.

Enumeration of the different object kinds.

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

This class is a simple placeholder used during the process of finding packages. Parameters: name: The package name. path: The pac

Exception for unhandled editables modules, when searching modules.

Directive information that has been parsed from a docstring.

Exception for alias that cannot be resolved.

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

Specific breakage class for removed base classes.

This class represents an admonition.

This class represents a documented deprecated item.

This class represents a deprecated section.

Enumeration of the possible styles for explanations.

Boolean operations like `a or b`.

Comparisons like `a > b`.

Comprehensions like `a for b in c if d`.

Dictionaries like `{"a": 0}`.

Dict comprehensions like `{k: v for k, v in a}`.

Formatted string like `{1 + 1}`.

Generator expressions like `a for b in c for d in e`.

Conditions like `a if b else c`.

Template string interpolation like `{name}`.

Joined strings like `f"a {b} c"`.

Keyword arguments like `a=b`.

Lambda expressions like `lambda a: a.b`.

Lists like `[0, 1, 2]`.

List comprehensions like `[a for b in c]`.

Named/assignment expressions like `a := b`.

Parameters in function signatures like `a: int = 0`.

Sets like `{0, 1, 2}`.

Set comprehensions like `{a for b in c}`.

Slices like `[a:b:c]`.

Template strings like `t"a {name}"`.

Unary operations like `-1`.

Variadic keyword parameters like `**kwargs`.