Append a name to this attribute. Parameters: value: The expression name to append.

Return this alias' data as a dictionary. See also: [`as_json`][griffe.Alias.as_json]. Parameters: full: Whether to retur

Yield a function to parse Google docstrings. Yields: A parser function.

Call the extension hook for the given event. Parameters: event: The triggered event. **kwargs: Arguments passed to th

Create and visit a temporary module with the given code. Parameters: code: The code of the module. module_name: The name of the t

Log a warning when parsing a docstring. This function logs a warning message by prefixing it with the filepath and line number. Parameters:

Yield a function to parse Sphinx docstrings. Yields: A parser function.

Yield a function to parse Numpy docstrings. Yields: A parser function.

Load an object as a Griffe object, given its Python or file path. Note that this will load the whole object's package, and return onl

Resolve a name within this object's and parents' scope. Parameters: name: The name to resolve. Raises: NameR

Create and visit a temporary package. Parameters: package: The package name. Example: `"a"` gives a package named `a`, while

Return the collection values. Returns: The collection values.

Parse a string into a true name or expression that can be resolved later. Parameters: annotation: The annotation to parse. docstr

Create a package containing the given modules in a temporary directory. Parameters: package: The package name. Example: `"a"` gives

Return the collection items. Returns: The collection items.

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

Return this target's data as a JSON string. See also: [`as_dict`][griffe.Alias.as_dict]. Parameters: full: Whether to re

Load configured extensions. Parameters: exts: Extensions with potential configuration options. Returns: An extensions contai

Add extensions to this container. Parameters: *extensions: The extensions to add.

Initialize the element. Parameters: annotation: The element annotation, if any. description: The element description.

Create and inspect a temporary module with the given code. Parameters: code: The code of the module. module_name: The name of the

Resolve aliases. Parameters: implicit: When false, only try to resolve an alias if it is explicitly exported. externa

Apply a separator between elements. The caller is assumed to provide their own grouping (e.g. lists, tuples, slice) and will prevent parenthe

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

Add a parameter to the container. Parameters: parameter: The function parameter to add. Raises: ValueError:

Create an instance of this class from a JSON string. Parameters: json_string: JSON to decode into Object. **kwargs: A

Handle a function. Parameters: node: The node to inspect. labels: Labels to add to the data object.

Modernize the expression. For example, use PEP 604 type unions `|` instead of `typing.Union`. Returns: A modernized expr

Run a command in the default virtual environment. ```bash make run <CMD> [ARG...] ``` This command runs an arbitrary command inside

Return the children of an AST node. Parameters: node: The AST node. Yields: The node children.

Load and return a module from a specific Git reference. This function will create a temporary [git worktree](https://git-scm.com/docs/git-wor

Inspect a module. Sometimes we cannot get the source code of a module or an object, typically built-in modules like `itertools`. The only

Iterate on the expression elements. Parameters: flat: Expressions are trees. When flat is false, this method ite

Safely (no exception) build a resolvable annotation. Parameters: node: The annotation node. parent: The parent used to resolve th

Initialize the alias. Parameters: name: The alias name. target: If it's a string, the target resolution is delayed un

Find the top-level parent module of a module. If a Path is passed, only try to find the module as a file path. If a string is passed,

Load and return a Griffe object. In Griffe's context, loading means: - searching for a package, and finding it on the file system or as a bu

Expand wildcards: try to recursively expand all found wildcards. See also: [`Alias.wildcard`][griffe.Alias.wildcard]. Parameters:

Find breaking changes between two versions of the same API. The function will iterate recursively on all objects and yield breaking changes w

Find a package or namespace package. Parameters: module_name: The module name. Raises: ModuleNotFoundError:

Extend the base generic visit with extensions. Parameters: node: The node to visit.

Tell if this object has all the given labels. See also: [`labels`][griffe.Alias.labels]. Parameters: *labels: Labels tha

Return the collection keys. Returns: The collection keys.

Return a list of classes in order corresponding to Python's MRO.

Run a command for all configured Python versions. ```bash make multirun <CMD> [ARG...] ``` This command runs an arbitrary command in

Parse the docstring into structured data. See also: [`parser`][griffe.Docstring.parser], [`parser_options`][griffe.Docstring.parser_o

Create and inspect a temporary package. Parameters: package: The package name. Example: `"a"` gives a package named `a`, whil

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

Dynamically import the specified object. It can be a module, class, method, function, attribute, type alias, nested arbitrarily. It work