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.47.0 #121

Closed
wants to merge 1 commit into from

Conversation

dependabot[bot]
Copy link

@dependabot dependabot bot commented on behalf of github Jul 1, 2024

Bumps griffe from 0.27.3 to 0.47.0.

Release notes

Sourced from griffe's releases.

0.47.0

0.47.0 - 2024-06-18

Compare with 0.46.1

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

Deprecations

  • The has_private_name and has_special_name properties on objects and aliases have been renamed is_private and is_special. The is_private property now only returns true if the name is not special.

Features

  • Add deprecated attribute and is_deprecated property to objects/aliases (2a75d84 by Timothée Mazzucotelli).
  • Add is_imported property to objects/aliases (de926cc by Timothée Mazzucotelli).
  • Add is_class_private property to objects/aliases (491b6c4 by Timothée Mazzucotelli).

Code Refactoring

  • Rename has_private_name and has_special_name to is_private and is_special (ae7c7e7 by Timothée Mazzucotelli).

0.46.1

0.46.1 - 2024-06-17

Compare with 0.46.0

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

Bug Fixes

  • Always consider special objects ("dunder" attributes/methods/etc.) to be public (3319410 by Timothée Mazzucotelli). Issue-294, Issue-295
  • Don't consider imported objects as public (ea90952 by Timothée Mazzucotelli). Discussion-169

0.46.0

0.46.0 - 2024-06-16

Compare with 0.45.3

WARNING: ⚡ Imminent v1! ⚡🚀 We are working on v1, and it will come soon, so we recommend that you consider adding an upper bound on Griffe. Version 1 will remove all legacy code! There will be a couple more v0 before so that you get all the deprecation warnings needed to upgrade your code using Griffe before upgrading to v1. See breaking changes and deprecations for v0.46 below.

Breaking Changes

We are still in v0, so no major bump yet.

  • Calling objects' [has_labels()][griffe.Object.has_labels] method with a labels keyword argument is not supported anymore. The parameter became a variadic positional parameter, so it cannot be used as a keyword argument anymore. Passing a sequence instead of multiple positional arguments still works but will emit a deprecation warning.
  • Calling the [load_extensions()][griffe.load_extensions] function with an exts keyword argument is not supported anymore. The parameter became a variadic positional parameter, so it cannot be used as a keyword argument anymore. Passing a sequence instead of multiple positional arguments still works but will emit a deprecation warning.

Deprecations

... (truncated)

Changelog

Sourced from griffe's changelog.

0.47.0 - 2024-06-18

Compare with 0.46.1

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

Deprecations

  • The has_private_name and has_special_name properties on objects and aliases have been renamed is_private and is_special. The is_private property now only returns true if the name is not special.

Features

  • Add deprecated attribute and is_deprecated property to objects/aliases (2a75d84 by Timothée Mazzucotelli).
  • Add is_imported property to objects/aliases (de926cc by Timothée Mazzucotelli).
  • Add is_class_private property to objects/aliases (491b6c4 by Timothée Mazzucotelli).

Code Refactoring

  • Rename has_private_name and has_special_name to is_private and is_special (ae7c7e7 by Timothée Mazzucotelli).

0.46.1 - 2024-06-17

Compare with 0.46.0

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

Bug Fixes

  • Always consider special objects ("dunder" attributes/methods/etc.) to be public (3319410 by Timothée Mazzucotelli). Issue-294, Issue-295
  • Don't consider imported objects as public (ea90952 by Timothée Mazzucotelli). Discussion-169

0.46.0 - 2024-06-16

Compare with 0.45.3

WARNING: ⚡ Imminent v1! ⚡🚀 We are working on v1, and it will come soon, so we recommend that you consider adding an upper bound on Griffe. Version 1 will remove all legacy code! There will be a couple more v0 before so that you get all the deprecation warnings needed to upgrade your code using Griffe before upgrading to v1. See breaking changes and deprecations for v0.46 below.

Breaking Changes

We are still in v0, so no major bump yet.

  • Calling objects' [has_labels()][griffe.Object.has_labels] method with a labels keyword argument is not supported anymore. The parameter became a variadic positional parameter, so it cannot be used as a keyword argument anymore. Passing a sequence instead of multiple positional arguments still works but will emit a deprecation warning.
  • Calling the [load_extensions()][griffe.load_extensions] function with an exts keyword argument is not supported anymore. The parameter became a variadic positional parameter, so it cannot be used as a keyword argument anymore. Passing a sequence instead of multiple positional arguments still works but will emit a deprecation warning.

Deprecations

  • As seen above in the breaking changes section, the only parameters of [Object.has_labels()][griffe.Object.has_labels] and [load_extensions()][griffe.load_extensions] both became variadic positional parameters. Passing a sequence as single argument is deprecated in favor of passing multiple arguments. This is an ergonomic change: I myself often forgot to wrap extensions in a list. Passing sequences of labels (lists, sets, tuples) is also difficult from Jinja templates.
  • The following methods and properties on objects and aliases are deprecated: [member_is_exported()][griffe.Object.member_is_exported], [is_explicitely_exported][griffe.mixins.ObjectAliasMixin.is_explicitely_exported], [is_implicitely_exported][griffe.mixins.ObjectAliasMixin.is_implicitely_exported]. Use the [is_exported][griffe.mixins.ObjectAliasMixin.is_exported] property instead. See issue 281.
  • The [is_exported()][griffe.mixins.ObjectAliasMixin.is_exported] and [is_public()][griffe.mixins.ObjectAliasMixin.is_public] methods became properties. They can still be called like methods, but will emit deprecation warnings when doing so. See issue 281.

... (truncated)

Commits
  • ce186a4 chore: Prepare release 0.47.0
  • 2a75d84 feat: Add deprecated attribute and is_deprecated property to objects/aliases
  • 1982023 docs: Add comments to is_wildcard_exposed
  • de926cc feat: Add is_imported property to objects/aliases
  • 491b6c4 feat: Add is_class_private property to objects/aliases
  • ae7c7e7 refactor: Rename has_private_name and has_special_name to is_private an...
  • 1ebfa63 style: Spacing
  • 40ebec0 chore: Prepare release 0.46.1
  • 3319410 fix: Always consider special objects ("dunder" attributes/methods/etc.) to be...
  • ea90952 fix: Don't consider imported objects as public
  • 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.47.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.47.0)

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

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Jul 1, 2024
Copy link
Author

dependabot bot commented on behalf of github Jul 16, 2024

Superseded by #127.

@dependabot dependabot bot closed this Jul 16, 2024
@dependabot dependabot bot deleted the dependabot/pip/griffe-0.47.0 branch July 16, 2024 00:41
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