Guard type hinting via ruff #166
Merged
Conversation
This file contains 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
notatallshaw
force-pushed
the
guard-type-hinting
branch
from
cc33ded
to
bd641ab
Compare
pyproject.toml
Outdated
| @@ -97,7 +98,7 @@ exclude = [ | |||
| ] | |||
|
|
|||
| [tool.ruff.lint.isort] | |||
| known-first-party = ["resolvelib"] | |||
| required-imports = ["from __future__ import annotations"] | |||
There was a problem hiding this comment.
There's also the FA rules, which might make this setting redundant :)
There was a problem hiding this comment.
In the past I found FA rules didn't always enable from __future__ import annotations when I expected, but looking at this PR it seems like all the additional from __future__ import annotations aren't stictly necessary.
I've updated to use FA instead, it makes the PR a lot less noisey. Thanks.
notatallshaw
force-pushed
the
guard-type-hinting
branch
from
bd641ab
to
b7df1ee
Compare
|
FYI, this actually appears to catch a bug by correctly moving It seems like no test case is triggering this test code path, if no one else does I will take a look in the coming weeks. |
pradyunsg
approved these changes
Aug 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR builds on top of #165
I notice it's a common pattern in this library, and one I prefer, to use
from __future__ import annotationsand guard type hint only imports behindif TYPE_CHECKING, this can be implemented automatically with ruff using:required-imports = ["from __future__ import annotations"]with the isort rules and the TCH rules: https://docs.astral.sh/ruff/rules/#flake8-type-checking-tch (namely TCH001, TCH002, and TCH003).I updated the config than then just ran a series of ruff --fix commands for the remaining commits (I have documented them to be clear).
Let me know if this is to your liking or not.