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

Bump griffe from 0.27.3 to 0.49.0 #130

Closed
wants to merge 1 commit into from

Conversation

dependabot[bot]
Copy link

@dependabot dependabot bot commented on behalf of github Aug 15, 2024

Bumps griffe from 0.27.3 to 0.49.0.

Release notes

Sourced from griffe's releases.

0.49.0

0.49.0 - 2024-08-14

Compare with 0.48.0

WARNING: ⚡ Imminent v1! ⚡🚀 See v0.46.

Deprecations

  • Cancel deprecation of get_logger and patch_loggers (and deprecate patch_logger instead). Extensions need loggers too, distinct ones, and they were forgotten... Sorry for the back and forth 🙇
  • Attributes setter and deleter on Function are deprecated. They were moved into the Attribute class since properties are instantiated as attributes, not functions.
  • Extension hooks must accept **kwargs in their signature, to allow forward-compatibility. Accepting **kwargs also makes it possible to remove unused arguments from the signature.
  • In version 1, Griffe will serialize object members as dictionaries instead of lists. Lists were initially used to preserve source order, but source order can be re-obtained thanks to the line number attributes (lineno, endlineno). Version 0.49 is able to load both lists and dictionaries from JSON dumps, and version 1 will maintain this ability. However external tools loading JSON dumps will need to be updated.

Features

  • Add temporary_inspected_package helper (3c4ba16 by Timothée Mazzucotelli).
  • Accept alias resolution related parameters in temporary_visited_package (7d5408a by Timothée Mazzucotelli).
  • Accept inits parameter in temporary_visited_package (a4859b7 by Timothée Mazzucotelli).
  • Warn (DEBUG) when an object coming from a sibling, parent or external module instead of the current module or a submodule is exported (listed in __all__) (f82317a by Timothée Mazzucotelli). Issue-249, Related-to-PR-251
  • Pass down agent to extension hooks (71acb01 by Timothée Mazzucotelli). Issue-312
  • Add source property to docstrings, which return the docstring lines as written in the source (3f6a71a by Timothée Mazzucotelli). Issue-90

Bug Fixes

  • Move setter and deleter to Attribute class instead of Function, since that's how properties are instantiated (309c6e3 by Timothée Mazzucotelli). Issue-311
  • Reduce risk of recursion errors by excluding imported objects from has_docstrings, unless they're public (9296ca7 by Timothée Mazzucotelli). Issue-302
  • Fix retrieval of annotations from parent for Yields section in properties (8a21f4d by Timothée Mazzucotelli). Issue-298
  • Fix parsing Yields section (Google-style) when yielded values are tuples, and the description has more lines than tuple values (9091776 by Timothée Mazzucotelli).
  • Fix condition on objects kinds when merging stubs (727f99b by Timothée Mazzucotelli).

Code Refactoring

  • Sort keys when dumping JSON from the command line (8cdffe9 by Timothée Mazzucotelli). Issue-310
  • Handle both lists and dicts for members when loading JSON data in preparation of v1 (f89050c by Timothée Mazzucotelli). Issue-310
  • Accept **kwargs in extension hooks to allow forward-compatibility (2621d52 by Timothée Mazzucotelli). Issue-312
  • Revert deprecation of patch_loggers in favor of patch_logger (a20796a by Timothée Mazzucotelli).
  • Expose dummy load_pypi in non-Insiders version (a69cffd by Timothée Mazzucotelli).
  • Don't emit deprecation warnings through own usage of deprecated API (9922d74 by Timothée Mazzucotelli). Issue-mkdocstrings#676
  • Finish preparing docstring style auto-detection feature (03bdec6 by Timothée Mazzucotelli). Issue-5
  • Add DocstringStyle literal type to prepare docstring style auto detection feature (b7aaf64 by Timothée Mazzucotelli). Issue-5
  • Inherit from str, Enum instead of StrEnum which needs a backport (77f1544 by Timothée Mazzucotelli). Issue-307

0.48.0

0.48.0 - 2024-07-15

Compare with 0.47.0

WARNING: ⚡ Imminent v1! ⚡🚀 See v0.46.

... (truncated)

Changelog

Sourced from griffe's changelog.

0.49.0 - 2024-08-14

Compare with 0.48.0

WARNING: ⚡ Imminent v1! ⚡🚀 See v0.46.

Deprecations

  • Cancel deprecation of get_logger and patch_loggers (and deprecate patch_logger instead). Extensions need loggers too, distinct ones, and they were forgotten... Sorry for the back and forth 🙇
  • Attributes setter and deleter on Function are deprecated. They were moved into the Attribute class since properties are instantiated as attributes, not functions.
  • Extension hooks must accept **kwargs in their signature, to allow forward-compatibility. Accepting **kwargs also makes it possible to remove unused arguments from the signature.
  • In version 1, Griffe will serialize object members as dictionaries instead of lists. Lists were initially used to preserve source order, but source order can be re-obtained thanks to the line number attributes (lineno, endlineno). Version 0.49 is able to load both lists and dictionaries from JSON dumps, and version 1 will maintain this ability. However external tools loading JSON dumps will need to be updated.

Features

  • Add temporary_inspected_package helper (3c4ba16 by Timothée Mazzucotelli).
  • Accept alias resolution related parameters in temporary_visited_package (7d5408a by Timothée Mazzucotelli).
  • Accept inits parameter in temporary_visited_package (a4859b7 by Timothée Mazzucotelli).
  • Warn (DEBUG) when an object coming from a sibling, parent or external module instead of the current module or a submodule is exported (listed in __all__) (f82317a by Timothée Mazzucotelli). Issue-249, Related-to-PR-251
  • Pass down agent to extension hooks (71acb01 by Timothée Mazzucotelli). Issue-312
  • Add source property to docstrings, which return the docstring lines as written in the source (3f6a71a by Timothée Mazzucotelli). Issue-90

Bug Fixes

  • Move setter and deleter to Attribute class instead of Function, since that's how properties are instantiated (309c6e3 by Timothée Mazzucotelli). Issue-311
  • Reduce risk of recursion errors by excluding imported objects from has_docstrings, unless they're public (9296ca7 by Timothée Mazzucotelli). Issue-302
  • Fix retrieval of annotations from parent for Yields section in properties (8a21f4d by Timothée Mazzucotelli). Issue-298
  • Fix parsing Yields section (Google-style) when yielded values are tuples, and the description has more lines than tuple values (9091776 by Timothée Mazzucotelli).
  • Fix condition on objects kinds when merging stubs (727f99b by Timothée Mazzucotelli).

Code Refactoring

  • Sort keys when dumping JSON from the command line (8cdffe9 by Timothée Mazzucotelli). Issue-310
  • Handle both lists and dicts for members when loading JSON data in preparation of v1 (f89050c by Timothée Mazzucotelli). Issue-310
  • Accept **kwargs in extension hooks to allow forward-compatibility (2621d52 by Timothée Mazzucotelli). Issue-312
  • Revert deprecation of patch_loggers in favor of patch_logger (a20796a by Timothée Mazzucotelli).
  • Expose dummy load_pypi in non-Insiders version (a69cffd by Timothée Mazzucotelli).
  • Don't emit deprecation warnings through own usage of deprecated API (9922d74 by Timothée Mazzucotelli). Issue-mkdocstrings#676
  • Finish preparing docstring style auto-detection feature (03bdec6 by Timothée Mazzucotelli). Issue-5
  • Add DocstringStyle literal type to prepare docstring style auto detection feature (b7aaf64 by Timothée Mazzucotelli). Issue-5
  • Inherit from str, Enum instead of StrEnum which needs a backport (77f1544 by Timothée Mazzucotelli). Issue-307

0.48.0 - 2024-07-15

Compare with 0.47.0

WARNING: ⚡ Imminent v1! ⚡🚀 See v0.46.

Deprecations

... (truncated)

Commits
  • 901a306 chore: Prepare release 0.49.0
  • d56da0a chore: Update Yore comments
  • 8cdffe9 refactor: Sort keys when dumping JSON from the command line
  • f89050c refactor: Handle both lists and dicts for members when loading JSON data in p...
  • 23da375 tests: Update tests to use new temporary_inspected_package helper
  • 3c4ba16 feat: Add temporary_inspected_package helper
  • 7d5408a feat: Accept alias resolution related parameters in temporary_visited_package
  • a4859b7 feat: Accept inits parameter in temporary_visited_package
  • 05c3ad3 tests: Allow clear_sys_modules to automatically clear all temporary modules
  • f82317a feat: Warn when an object coming from a sibling, parent or external module i...
  • Additional commits viewable in compare view

Dependabot compatibility score

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

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

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

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Aug 15, 2024
Copy link
Author

dependabot bot commented on behalf of github Aug 19, 2024

Superseded by #131.

@dependabot dependabot bot closed this Aug 19, 2024
@dependabot dependabot bot deleted the dependabot/pip/griffe-0.49.0 branch August 19, 2024 00:22
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants