Skip to content

Conversation

@dependabot
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Sep 8, 2025

Bumps griffe from 1.13.0 to 1.14.0.

Release notes

Sourced from griffe's releases.

1.14.0

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).
Changelog

Sourced from griffe's changelog.

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).
Commits
  • 396cc03 chore: Prepare release 1.14.0
  • b6169cd docs: Minor fix/improvemt
  • 7474343 docs: Remove redudant docstring sections (auto-summarized)
  • d792a56 feat: Add analysis attribute on objects and aliases, telling whether they w...
  • 2a8d824 feat: Expose Git info in objects, allowing to compute a new source_link pro...
  • bff6f61 docs: Improve docs for Docstring.source
  • c1290e7 chore: Add TODO comment
  • 945880a refactor: Provide typed dicts for docstring options
  • f1ad8df ci: Set "deploy" mode when checking docs in CI
  • b4e9f08 style: Remove trailing spaces
  • Additional commits viewable in compare view

Dependabot compatibility score

You can trigger a rebase of this PR by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Note
Automatic rebases have been disabled on this pull request as it has been open for over 30 days.

Bumps [griffe](https://github.com/mkdocstrings/griffe) from 1.13.0 to 1.14.0.
- [Release notes](https://github.com/mkdocstrings/griffe/releases)
- [Changelog](https://github.com/mkdocstrings/griffe/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/griffe@1.13.0...1.14.0)

---
updated-dependencies:
- dependency-name: griffe
  dependency-version: 1.14.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update python code labels Sep 8, 2025
@coveralls
Copy link

Pull Request Test Coverage Report for Build 17548692785

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 81.851%

Totals Coverage Status
Change from base Build 17380512627: 0.0%
Covered Lines: 672
Relevant Lines: 821

💛 - Coveralls

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file python Pull requests that update python code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants