Skip to content

refactor: ♻️ update deprecated usage to use typing.deprecated #2828

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Paillat-dev
Copy link
Contributor

Summary

Fixes #1917
Redo of #2655

The previous version of the PR did not work correctly with type checkers, this one does, with the compromise of needing to use the @deprecated(deprecated_message(...)) syntax. This allows for type checkers to mark methods as deprecated and do some kind of strike trough like shown below:

image

Information

  • This PR fixes an issue.
  • This PR adds something new (e.g. new method or parameters).
  • This PR is a breaking change (e.g. methods or parameters removed/renamed).
  • This PR is not a code change (e.g. documentation, README, typehinting,
    examples, ...).

Checklist

  • I have searched the open pull requests for duplicates.
  • If code changes were made then they have been tested.
    • I have updated the documentation to reflect the changes.
  • If type: ignore comments were used, a comment is also left explaining why.
  • I have updated the changelog to include these changes.

@@ -283,16 +282,15 @@ def decorator(overridden: T) -> T:
return decorator


def warn_deprecated(
def deprecated_message(
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The git diff makes it look like warn_deprecated was removed, but it wasn't see below.

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

Successfully merging this pull request may close these issues.

Update utils.deprecated to use PEP 702
1 participant