Releases: mkdocstrings/griffe
Releases · mkdocstrings/griffe
1.14.0
1.14.0 - 2025-09-05
Deprecations
- The
on_alias
event's signature changed fromon_alias(self, *, node: AST | ObjectNode, alias: Alias, agent: Visitor | Inspector, **kwargs)
(an [analysis event][analysis-events]) toon_alias(self, *, alias: Alias, loader: GriffeLoader, **kwargs)
([a load event][load-events]). Use the new signature, or rename your method toon_alias_instance
to keep the old signature (on_alias_instance
is a new analysis event that replaces the oldon_alias
one). Backward compatibility is maintained until next major version. - The
on_wildcard_expansion
event is deprecated. Instead, use theon_alias
event, and check the [wildcard_imported
][griffe.Alias.wildcard_imported] boolean attribute of aliases. - The
on_package_loaded
event is renamed toon_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
andtmp_worktree
) is deprecated, as they are not a core part of the library's functionality. These utilities are now part of our internal API.
Features
- 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, deprecateon_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
Code Refactoring
- 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
andon_package_loaded
(d3e50db by Timothée Mazzucotelli).
1.13.0
1.12.1
1.12.1 - 2025-08-14
Code Refactoring
1.12.0
1.12.0 - 2025-08-14
Features
- Allow disabling "missing type/annotation" warnings (07564b4 by Timothée Mazzucotelli). Issue-mkdocstrings-437
1.11.1
1.11.0
1.10.0
1.9.0
1.9.0 - 2025-07-28
Features
- Support PEP 695 generics (be28e9c by Victor Westerhuis). Issue-342, PR-348, Co-authored-by: Timothée Mazzucotelli [email protected]
1.8.0
1.8.0 - 2025-07-23
Features
- Add method to functions and classes to build and return a stringified signature (8ef1486 by ISOREX). Discussion-376, PR-381, Co-authored-by: Timothée Mazzucotelli [email protected]
- Enhance Sphinx-style parameter parsing to handle invalid type info (cbce5a2 by Edouard Choinière). PR-396
- Parse Sphinx parameter types as expressions (70dda21 by Edouard Choinière). PR-392
Bug Fixes
- Avoid SyntaxError when loading modules encoded in UTF8 with BOM (b346190 by John Hennig). Issue-386, PR-387, Co-authored-by: Timothée Mazzucotelli [email protected]
- Correctly parenthesize expressions (a8c5585 by Abraham Cheung). PR-389, Co-authored-by: Timothée Mazzucotelli [email protected]
Code Refactoring
1.7.3
1.7.3 - 2025-04-23
Bug Fixes
Code Refactoring
- Log a debug message when inspecting a module raises an error (4e73b3e by Timothée Mazzucotelli). Issue-mkdocstrings-753