Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update griffe requirement from <0.22.0,>=0.20.0 to >=0.20.0,<0.26.0 #46

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dependabot[bot]
Copy link

@dependabot dependabot bot commented on behalf of github Dec 12, 2022

Updates the requirements on griffe to permit the latest version.

Changelog

Sourced from griffe's changelog.

0.25.0 - 2022-12-11

Compare with 0.24.1

Breaking changes

  • Parameter only_known_modules was renamed external in the [expand_wildcards()][griffe.loader.GriffeLoader.expand_wildcards] method of the loader.
  • Exception UnhandledEditablesModuleError was renamed UnhandledEditableModuleError since we now support editable installation from other packages than editables.

Highlights

  • Properties are now fetched as attributes rather than functions, since that is how they are used. This was asked by users, and since Griffe generates signatures for Python APIs (emphasis on APIs), it makes sense to return data that matches the interface provided to users. Such property objects in Griffe's output will still have the associated property labels of course.
  • Lots of bug fixes. These bugs were discovered by running Griffe on many major packages as well as the standard library (again). Particularly, alias resolution should be more robust now, and should generate less issues like cyclic aliases, meaning indirect/wildcard imports should be better understood. We still highly discourage the use of wilcard imports 😀

Features

Bug Fixes

  • Prevent cyclic alias creation when expanding wildcards (a77e4e8 by Timothée Mazzucotelli).
  • Don't crash and show hint when wildcard expansion fails (336faf6 by Timothée Mazzucotelli).
  • Register top module after inspection (86454ec by Timothée Mazzucotelli).
  • Set alias attributes early (2ac1a9b by Timothée Mazzucotelli).
  • Allow writing attributes on aliases (c8f736e by Timothée Mazzucotelli).
  • Don't crash on inspection of functions signatures (051e337 by Timothée Mazzucotelli).
  • Don't crash on inspection of method descriptors' docstrings (09571bb by Timothée Mazzucotelli).
  • Fix stats computing (handle stubs and namespace packages) (a81f8dc by Timothée Mazzucotelli).
  • Support documenting multiple items for optional tuples (727456d by Timothée Mazzucotelli). [Issue #117](mkdocstrings/griffe#117)
  • Fix comparing names with strings (37ae0a2 by Timothée Mazzucotelli). [Issue #114](mkdocstrings/griffe#114)
  • Fix deepcopy crashing because of __getattr__ (11b023b by Timothée Mazzucotelli). [Issue #73](mkdocstrings/griffe#73), [PR #119](mkdocstrings/griffe#119)

Code Refactoring

  • Prevent reloading of failed modules (8ef14ab by Timothée Mazzucotelli).
  • Rename only_known_modules parameter to external (5f816c6 by Timothée Mazzucotelli).
  • Rework alias creation decision in the inspector (f434943 by Timothée Mazzucotelli).
  • Resolve alias chain recursively (6cdd3b2 by Timothée Mazzucotelli).
  • Don't try to stubs-merge identical modules (7099971 by Timothée Mazzucotelli).
  • Load properties as attributes (5c97a45 by Timothée Mazzucotelli). [Issue mkdocstrings/python#9](mkdocstrings/python#9)
  • Use a cyclic relationship map for inspection (9a2a711 by Timothée Mazzucotelli). [PR #115](mkdocstrings/griffe#115)

0.24.1 - 2022-11-18

Compare with 0.24.0

Bug Fixes

  • Support nested namespace packages (d571f8f by Timothée Mazzucotelli).

0.24.0 - 2022-11-13

Compare with 0.23.0

... (truncated)

Commits
  • 108d32e chore: Prepare release 0.25.0
  • abc18f7 feat: Support setuptools editable modules
  • a77e4e8 fix: Prevent cyclic alias creation when expanding wildcards
  • 336faf6 fix: Don't crash and show hint when wildcard expansion fails
  • 8ef14ab refactor: Prevent reloading of failed modules
  • 5f816c6 refactor: Rename only_known_modules parameter to external
  • f434943 refactor: Rework alias creation decision in the inspector
  • 6cdd3b2 refactor: Resolve alias chain recursively
  • 86454ec fix: Register top module after inspection
  • b73a0ef chore: Template upgrade
  • Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually 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 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)

Updates the requirements on [griffe](https://github.com/mkdocstrings/griffe) to permit the latest version.
- [Release notes](https://github.com/mkdocstrings/griffe/releases)
- [Changelog](https://github.com/mkdocstrings/griffe/blob/master/CHANGELOG.md)
- [Commits](mkdocstrings/griffe@0.20.0...0.25.0)

---
updated-dependencies:
- dependency-name: griffe
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot @github
Copy link
Author

dependabot bot commented on behalf of github Dec 12, 2022

The following labels could not be found: maintenance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants