Run when visiting a new type alias node during static/dynamic analysis. Parameters: node: The currently visited node.

The overloaded signatures declared in this class/module or for this function.

The absolute top module (the package) of this object. See also: [`module`][griffe.Object.module]. Examples: >>> import g

The absolute top module (the package) of this object. See also: [`module`][griffe.Alias.module].

The parameters of the current function or `__init__` method for classes. This property can fetch inherited members, and therefore is

The parameters of this class' `__init__` method, if any. This property fetches inherited members, and therefore is part of the consum

The parent of this alias.

Whether the object of this node's parent is a class.

Parse a docstring by automatically detecting the style it uses. See [`infer_docstring_style`][griffe.infer_docstring_style] for more information

Parse a Google-style docstring. This function iterates on lines of a docstring to build sections. It then returns this list of sections.

Parse a Numpydoc-style docstring. This function iterates on lines of a docstring to build sections. It then returns this list of sections.

Parse a Sphinx-style docstring. Parameters: docstring: The docstring to parse. warn_unknown_params: Warn about documented paramet

The docstring sections, parsed into structured data.

Patch Griffe logger and Griffe extensions' loggers. Parameters: get_logger_func: A function accepting a name as parameter and returning a

Path of the expressed name/attribute.

The path of this attribute.

The full, resolved name. If it was given when creating the name, return that. If a callable was given, call it and return its result.

The path of this subscript's left part.

The dotted path of this object. On regular objects (not aliases), the path is the canonical path. See also: [`canonical_path`][griff

The dotted path / import path of this object. See also: [`canonical_path`][griffe.Alias.canonical_path].

The object's (Python) path.

Publish source and wheel distributions to PyPI. ```bash make publish ``` Publish the source and wheel distributions of your project

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 cur

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 cur

The file path where this object was defined, relative to the top module path. See also: [`filepath`][griffe.Object.filepath], [`relat

The file path where this object was defined, relative to the top module path. See also: [`filepath`][griffe.Alias.filepath], [`relati

Release a new version of the project. ```bash make release [version=VERSION] ``` This task will: - Stage changes to `pyproject.

Render Griffe's main entrypoint's docs. Parameters: heading_level: The initial level of Markdown headings.

Render Griffe's internal API's structure docs. This function prints Markdown headings, and the contents of the first comment block of a module,

Render Griffe's main module's docs. Parameters: heading_level: The initial level of Markdown headings.

Whether this parameter is required.

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

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

The resolved object this name refers to.

Whether this alias' target is resolved.

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

Resolved class bases. This method is part of the consumer API: do not use when producing Griffe trees! See also: [`bases`][g

The function return type annotation.

Safely (no exception) get the string representation of a node. Parameters: node: The node to represent. filepath: An optional fil

The setter linked to this function (property).

The function signature.

The class signature.

The original, uncleaned value of the docstring as written in the source. It is a simple concatenation of the source lines. These source lines

The source code of this object. See also: [`lines`][griffe.Object.lines], [`lines_collection`][griffe.Object.lines_collection].

The source code of this object. See also: [`lines`][griffe.Alias.lines], [`lines_collection`][griffe.Alias.lines_collection].

Source link for this object, if available.

Get the source link for this object, if available.

Tail of the dependency. The `islice` object is sufficient for iteration or testing membership (`in`).

Return self so that `__contains__` could be called.

The resolved target (actual object), if possible. Upon accessing this property, if the target is not already resolved, a lookup is do

Run the test suite. ```bash make test ``` Run the test suite with [Pytest](https://docs.pytest.org/) and plugins. Code source co

Assert wa can access the same members with both strings and tuples.

Test an empty "See Also" admonition. Parameters: parse_numpy: Fixture parser.

Test that the "Warnings" section renders as a warning admonition. Parameters: parse_numpy: Fixture parser.

Test a "See Also" admonition. Parameters: parse_numpy: Fixture parser.

Test that the "Warnings" section renders as a warning admonition. Parameters: parse_numpy: Fixture parser.

The Alias class has all the necessary methods and properties.

Test that all fields can be made keyword-only.

Test analysis events triggering.

Test analysis events triggering.

Names are correctly resolved in the annotation scope of an object.

Assert builtin types are correctly transformed to annotations.

Assert custom classes are correctly transformed to annotations.

Assert annotations are correctly converted to string.

Assert annotations are correctly converted to string.

All public objects are added to the inventory.

Parse attributes section. Parameters: parse_numpy: Fixture parser.

Dataclass attributes that have no annotatations are not parameters.

Avoid false positive when parsing sections. Parameters: parse_google: Fixture parser.

Support blank lines in the middle of item descriptions. Parameters: parse_numpy: Fixture parser. newlines: Number of new lines be

Support blank lines in the middle of sections. Parameters: parse_numpy: Fixture parser.

Test building annotations from AST nodes. Parameters: expression: An expression (parametrized).

Test building annotations from AST nodes. Parameters: code: An expression (parametrized).

Test the construction of a class/function signature.

Assert we can parse a docstring even if it does not have a parent module.

Assert annotations using class-level imports are resolved.

Assert we use the `__init__` parameters when parsing classes' parameters sections. Parameters: parse_google: Fixture parser.

Assert we use the `__init__` parameters when parsing classes' parameters sections. Parameters: parse_numpy: Fixture parser.

Assert class variable and instance variable annotations are correctly parsed and merged.

Test that `ClassVar` fields are not included in the `__init__` method.

Parse code blocks. Parameters: parse_google: Fixture parser.

Parse code blocks. Parameters: parse_numpy: Fixture parser.

Test computing MRO. Parameters: classes: A list of classes inheriting from each other. cls: The class to compute the MRO of.

Class parameters should have a docstring attribute.

Check dataclass and equivalent non-dataclass parameters. The parameter kinds for each pair should be the same. Parameters: code: Pyt

Don't return properties or class variables as parameters of dataclasses.

Test our `dataclass` support.

Assert we can deep-copy object trees.

Test getting default value from AST nodes. Parameters: default: A default value (parametrized).

Check that the deferred finder works as expected.

We can delete parameters.

We can delete type parameters.

Parse deprecated section. Parameters: parse_numpy: Fixture parser.

Detect the optional part of a parameter docstring. Parameters: parse_numpy: Fixture parser.

Dunder attributes (methods, etc.) must be considered public.

Test the different incompatibility finders. Parameters: old_code: Parametrized code of the old module version. new_code: Parametr

Parse different indentations, warn on confusing indentation. Parameters: parse_google: Fixture parser.