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

Only use typing-extensions if necessary #563

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

Conversation

ppentchev
Copy link
Contributor

@ppentchev ppentchev commented Feb 10, 2025

As discussed in #562 - a second PR that contains the change that makes the use of typing-extensions conditional on the Python version.

Thanks for your work on libtmux and tmuxp!

Summary by Sourcery

Enhancements:

  • Import typing.Self if Python version is greater than or equal to 3.11, otherwise import it from typing_extensions.

TypeAlias was included in the typing module in Python 3.10.
Self was included in the typing module in Python 3.11.
Copy link

sourcery-ai bot commented Feb 10, 2025

Reviewer's Guide by Sourcery

This pull request refactors the import logic for type annotations so that the usage of typing-extensions is conditional based on the Python version. The changes conditionally import Self and TypeAlias from either typing or typing-extensions depending on the Python version, reducing unnecessary dependencies when running on newer Python versions.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Conditional import of Self in the test module
  • Removed the unconditional import of Self from typing-extensions
  • Added conditional logic to import Self from typing when Python version is 3.11 or higher, otherwise importing from typing-extensions
src/libtmux/test.py
Conditional import of TypeAlias in the server module
  • Removed the direct import of TypeAlias from typing-extensions in the type checking block
  • Introduced conditional logic to import TypeAlias from typing for Python versions 3.10 and above, otherwise falling back to typing-extensions
src/libtmux/server.py
Conditional import of TypeAlias in test files for the legacy API and version tests
  • Removed the direct import of TypeAlias from typing-extensions in the type checking blocks
  • Added conditional statements to import TypeAlias from typing if the Python version is 3.10 or higher, otherwise importing from typing-extensions
tests/legacy_api/test_version.py
tests/test_version.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ppentchev - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a comment explaining why the version check is different for Self and TypeAlias.
  • It might be cleaner to define a helper function to handle the conditional import of Self and TypeAlias.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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

Successfully merging this pull request may close these issues.

1 participant