-
Notifications
You must be signed in to change notification settings - Fork 72
chore(deps): add typing_extensions for py<3.13 to have a fallback for "deprecated" #177
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,44 +1,16 @@ | ||
| """Provide a deprecated decorator for marking functions or classes as deprecated. | ||
|
|
||
| It first attempts to import the deprecated decorator from the warnings module, available | ||
| in Python 3.13 and later. If the import fails (indicating an earlier Python version), it | ||
| defines a custom deprecated decorator. The decorator from warnings issues a | ||
| DeprecationWarning when the decorated object is used during runtime, and triggers static | ||
| linters to flag the usage as deprecated. The custom decorator also issues a | ||
| DeprecationWarning when the decorated object is used, but does not trigger static | ||
| linters. | ||
| If the Python version is 3.13 or higher, it uses the | ||
| built-in ``warnings.deprecated`` decorator. | ||
| If the Python version is lower than 3.13, it falls back to using the | ||
| ``typing_extensions.deprecated`` decorator. | ||
| """ | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| try: | ||
| from warnings import deprecated # type: ignore [attr-defined, unused-ignore] | ||
| except ImportError: | ||
| import functools | ||
| from collections.abc import Callable | ||
| from typing import TypeVar, cast | ||
| from warnings import warn | ||
|
|
||
| F = TypeVar("F", bound=Callable[..., object]) | ||
|
|
||
| def deprecated( # type: ignore [no-redef, unused-ignore] | ||
| message: str, | ||
| /, | ||
| *, | ||
| category: type[Warning] | None = DeprecationWarning, | ||
| stacklevel: int = 1, | ||
| ) -> Callable[[F], F]: | ||
| """Indicate that a function is deprecated.""" | ||
|
|
||
| def decorator(func: F) -> F: | ||
| @functools.wraps(func) | ||
| def wrapper(*args: object, **kwargs: object) -> object: | ||
| warn(message, category=category, stacklevel=stacklevel) | ||
| return func(*args, **kwargs) | ||
|
|
||
| return cast("F", wrapper) | ||
|
|
||
| return decorator | ||
| import sys | ||
|
|
||
| if sys.version_info >= (3, 13): | ||
| from warnings import deprecated | ||
| else: | ||
| from typing_extensions import deprecated | ||
|
|
||
| __all__ = ["deprecated"] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.