All submodules are deprecated. All objects are now exposed in the top-level griffe module.
All logger names are deprecated, and will be replaced with "griffe" in v1. In v1 our single "griffe" logger will provide a method to temporarily disable logging, [logger.disable()][griffe.Logger.disable], since that's the most common third-party use.
The get_logger function is deprecated. Instead, we'll use a global logger internally, and users are welcome to use it too.
The patch_loggers function is renamed patch_logger.
Following the logging changes, the [docstring_warning][griffe.docstring_warning] function can now directly log a warning message instead of returning a callable that does. Passing it a logger name (to get a callable) is deprecated in favor of passing it a docstring, message and offset directly.
Features
Support FORCE_COLOR environment variable (e1b7bd9 by Timothée Mazzucotelli).
Bug Fixes
Don't take a shortcut to the end of an alias chain when getting/setting/deleting alias members (1930609 by Timothée Mazzucotelli).
Short-circuit __all__ convention when checking if a module is public (5abf4e3 by Timothée Mazzucotelli).
Reuse existing loggers, preventing overwriting issues (3c2825f by Timothée Mazzucotelli).
Ignore .pth files that are not utf-8 encoded (ea299dc by Andrew Sansom). Issue-300, PR-301
Attributes without annotations cannot be dataclass parameters (c9b2e09 by Hassan Kibirige). PR-297
When deciding to alias an object or not during inspection, consider module paths to be equivalent even with arbitrary private components (8c9f6e6 by Timothée Mazzucotelli). Issue-296
Fix target path computation: use qualified names to maintain classes in the path (6e17def by Timothée Mazzucotelli). Issue-296
Code Refactoring
Prepare loggers for simplification (381f10f by Timothée Mazzucotelli).
Add all previous modules for backward compatibility (a86e44e by Timothée Mazzucotelli).
Add main public modules (fb860b3 by Timothée Mazzucotelli).
Simplify "is imported" check in is_public property (c2bbc10 by Timothée Mazzucotelli).
Use string and integer enumerations (06b383b by Timothée Mazzucotelli).
Renamed agents nodes modules (ddc5b0c by Timothée Mazzucotelli).
Clean up and document internal API, mark legacy code (92594a9 by Timothée Mazzucotelli).
Renamed dataclasses internal modules to models (5555de6 by Timothée Mazzucotelli).
Move sources under _griffe internal package (cbce6a5 by Timothée Mazzucotelli).
All submodules are deprecated. All objects are now exposed in the top-level griffe module.
All logger names are deprecated, and will be replaced with "griffe" in v1. In v1 our single "griffe" logger will provide a method to temporarily disable logging, [logger.disable()][griffe.Logger.disable], since that's the most common third-party use.
The get_logger function is deprecated. Instead, we'll use a global logger internally, and users are welcome to use it too.
The patch_loggers function is renamed patch_logger.
Following the logging changes, the [docstring_warning][griffe.docstring_warning] function can now directly log a warning message instead of returning a callable that does. Passing it a logger name (to get a callable) is deprecated in favor of passing it a docstring, message and offset directly.
Features
Support FORCE_COLOR environment variable (e1b7bd9 by Timothée Mazzucotelli).
Bug Fixes
Don't take a shortcut to the end of an alias chain when getting/setting/deleting alias members (1930609 by Timothée Mazzucotelli).
Short-circuit __all__ convention when checking if a module is public (5abf4e3 by Timothée Mazzucotelli).
Reuse existing loggers, preventing overwriting issues (3c2825f by Timothée Mazzucotelli).
Ignore .pth files that are not utf-8 encoded (ea299dc by Andrew Sansom). Issue-300, PR-301
Attributes without annotations cannot be dataclass parameters (c9b2e09 by Hassan Kibirige). PR-297
When deciding to alias an object or not during inspection, consider module paths to be equivalent even with arbitrary private components (8c9f6e6 by Timothée Mazzucotelli). Issue-296
Fix target path computation: use qualified names to maintain classes in the path (6e17def by Timothée Mazzucotelli). Issue-296
Code Refactoring
Prepare loggers for simplification (381f10f by Timothée Mazzucotelli).
Add all previous modules for backward compatibility (a86e44e by Timothée Mazzucotelli).
Add main public modules (fb860b3 by Timothée Mazzucotelli).
Simplify "is imported" check in is_public property (c2bbc10 by Timothée Mazzucotelli).
Use string and integer enumerations (06b383b by Timothée Mazzucotelli).
Renamed agents nodes modules (ddc5b0c by Timothée Mazzucotelli).
Clean up and document internal API, mark legacy code (92594a9 by Timothée Mazzucotelli).
Renamed dataclasses internal modules to models (5555de6 by Timothée Mazzucotelli).
Move sources under _griffe internal package (cbce6a5 by Timothée Mazzucotelli).
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.
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 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 from 0.44.0 to 0.48.0.
Release notes
Sourced from griffe's releases.
... (truncated)
Changelog
Sourced from griffe's changelog.
... (truncated)
Commits
14a43abchore: Prepare release 0.48.0145e0bcdocs: Add missing pymdownx.blocks.tab extension4d93fd6docs: Copy readme contents from insiders repoab7ba17docs: Fix link in readme4bd9fb0ci: Run inventory tests in CI4e7ef6ctests: Ignore deprecated public module in api/inventory test7207449ci: Fix comparison0477db5ci: Don't use parameter headings insiders feature since it breaks in CI39a1174ci: Ignore dot subprocess error in CI5c154b3ci: Fix code block execution without direnvDependabot 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