Skip to content

Releases: mkdocstrings/griffe

1.14.0

05 Sep 15:02
Compare
Choose a tag to compare

1.14.0 - 2025-09-05

Compare with 1.13.0

Deprecations

  • 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.

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, 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

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 and on_package_loaded (d3e50db by Timothée Mazzucotelli).

1.13.0

26 Aug 13:27
Compare
Choose a tag to compare

1.13.0 - 2025-08-26

Compare with 1.12.1

Features

  • Add is_init_method property (5417b70 by Timothée Mazzucotelli).

Bug Fixes

  • Increase maximum recursion limit when calling as a CLI (5f0d9e6 by Timothée Mazzucotelli). Issue-402

1.12.1

14 Aug 21:08
Compare
Choose a tag to compare

1.12.1 - 2025-08-14

Compare with 1.12.0

Code Refactoring

  • Reduce size of JSON dumps by removing keys with null values (58227eb by Timothée Mazzucotelli). Issue-403
  • Add fields to aliases when serializing (5c9fee2 by Timothée Mazzucotelli).
  • Also add the option to ignore missing type to the Sphinx parser (8c9f803 by Timothée Mazzucotelli).

1.12.0

14 Aug 12:11
Compare
Choose a tag to compare

1.12.0 - 2025-08-14

Compare with 1.11.1

Features

1.11.1

11 Aug 11:38
Compare
Choose a tag to compare

1.11.1 - 2025-08-11

Compare with 1.11.0

Bug Fixes

  • Fix type parameters loading (ce41279 by Timothée Mazzucotelli).

Code Refactoring

  • Move private _griffe package under griffe._internal (8f37158 by Timothée Mazzucotelli).

1.11.0

07 Aug 18:23
Compare
Choose a tag to compare

1.11.0 - 2025-08-07

Compare with 1.10.0

Features

  • Add data to dict/json output (9731afc by Timothée Mazzucotelli).

1.10.0

06 Aug 09:19
Compare
Choose a tag to compare

1.10.0 - 2025-08-06

Compare with 1.9.0

Features

  • Allow adding sys.path to search paths when temporary visiting/inspecting package (42983bc by Timothée Mazzucotelli).

1.9.0

28 Jul 17:45
Compare
Choose a tag to compare

1.9.0 - 2025-07-28

Compare with 1.8.0

Features

1.8.0

22 Jul 23:46
Compare
Choose a tag to compare

1.8.0 - 2025-07-23

Compare with 1.7.3

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

Code Refactoring

  • Be more consistent regarding not overriding submodules with aliases (be1963c by Timothée Mazzucotelli).
  • Allow ExprName.parent to be of type griffe.Function (acafbd8 by Edouard Choinière). Issue-391, PR-395
  • Normalize labels for attributes (1b376cd by Timothée Mazzucotelli).

1.7.3

23 Apr 11:28
Compare
Choose a tag to compare

1.7.3 - 2025-04-23

Compare with 1.7.2

Bug Fixes

  • Don't output color codes with GitHub format (2666399 by Timothée Mazzucotelli). Issue-378

Code Refactoring