Release 1.14.0 · mkdocstrings/griffe

1.14.0 - 2025-09-05

The on_alias event's signature changed from on_alias(self, *, node: AST | ObjectNode, alias: Alias, agent: Visitor | Inspector, **kwargs) (an [analysis event][analysis-events]) to on_alias(self, *, alias: Alias, loader: GriffeLoader, **kwargs) ([a load event][load-events]). Use the new signature, or rename your method to on_alias_instance to keep the old signature (on_alias_instance is a new analysis event that replaces the old on_alias one). Backward compatibility is maintained until next major version.
The on_wildcard_expansion event is deprecated. Instead, use the on_alias event, and check the [wildcard_imported][griffe.Alias.wildcard_imported] boolean attribute of aliases.
The on_package_loaded event is renamed to on_package. Backward compatibility is maintained until next major version.
The use of previously exposed Git-related utilities (assert_git_repo, get_repo_root, get_latest_tag and tmp_worktree) is deprecated, as they are not a core part of the library's functionality. These utilities are now part of our internal API.

Add analysis attribute on objects and aliases, telling whether they were loaded through static or dynamic analysis, or created manually (d792a56 by Timothée Mazzucotelli).
Expose Git info in objects, allowing to compute a new source_link property (see [Source information][source-information] in our docs) (2a8d824 by Timothée Mazzucotelli). Issue-361, Issue-mkdocstrings-python-253
Add wildcard_imported boolean attribute to aliases, deprecate on_wildcard_expansion event (821300d by Timothée Mazzucotelli).
Add load events that run once a tree is fully constructed, matching analysis events but safer to hook onto (see [Load events][load-events] in our docs) (77f928a by Timothée Mazzucotelli). Issue-346

Provide typed dicts for docstring options (945880a by Timothée Mazzucotelli). Issue-370
Allow parenthesized type to be glued (no space) to parameter name in Google-style docstrings (4b6f939 by Timothée Mazzucotelli). Issue-375
Improve deprecation warnings for on_alias and on_package_loaded (d3e50db by Timothée Mazzucotelli).