[flake8-type-checking] Adds implementation for TC006
#14511
+309
−0
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
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| TC006 | 431 | 431 | 0 | 0 | 0 |
| TC001 | 117 | 117 | 0 | 0 | 0 |
| TC003 | 21 | 21 | 0 | 0 | 0 |
| E501 | 1 | 1 | 0 | 0 | 0 |
| TC002 | 1 | 1 | 0 | 0 | 0 |
|
The extra hits for the other rules make sense to me, since fixing In the case of |
MichaReiser
added
rule
MichaReiser
approved these changes
Nov 22, 2024
Comment on lines
+66
to
+79
| #[test_case(Rule::RuntimeCastValue, Path::new("TC006.py"))] | ||
| fn preview_rules(rule_code: Rule, path: &Path) -> Result<()> { | ||
| let snapshot = format!("preview__{}_{}", rule_code.as_ref(), path.to_string_lossy()); | ||
| let diagnostics = test_path( | ||
| Path::new("flake8_type_checking").join(path).as_path(), | ||
| &settings::LinterSettings { | ||
| preview: PreviewMode::Enabled, | ||
| ..settings::LinterSettings::for_rule(rule_code) | ||
| }, | ||
| )?; | ||
| assert_messages!(snapshot, diagnostics); | ||
| Ok(()) | ||
| } | ||
|
|
There was a problem hiding this comment.
I know this is a pattern that we have in other linter-groups too, but I don't think it's actually necessary to test a preview-rule. It's only necessary if the rule depends on any other preview-only behavior
Comment on lines
+57
to
+67
| let edit = quote_type_expression(type_expr, checker.semantic(), checker.stylist()).ok(); | ||
| if let Some(edit) = edit.as_ref() { | ||
| if checker | ||
| .comment_ranges() | ||
| .has_comments(type_expr, checker.source()) | ||
| { | ||
| diagnostic.set_fix(Fix::unsafe_edit(edit.clone())); | ||
| } else { | ||
| diagnostic.set_fix(Fix::safe_edit(edit.clone())); | ||
| } | ||
| } |
There was a problem hiding this comment.
The clone calls here seem unnecessary
Suggested change
| let edit = quote_type_expression(type_expr, checker.semantic(), checker.stylist()).ok(); | |
| if let Some(edit) = edit.as_ref() { | |
| if checker | |
| .comment_ranges() | |
| .has_comments(type_expr, checker.source()) | |
| { | |
| diagnostic.set_fix(Fix::unsafe_edit(edit.clone())); | |
| } else { | |
| diagnostic.set_fix(Fix::safe_edit(edit.clone())); | |
| } | |
| } | |
| let edit = quote_type_expression(type_expr, checker.semantic(), checker.stylist()).ok(); | |
| if let Some(edit) = edit { | |
| if checker | |
| .comment_ranges() | |
| .has_comments(type_expr, checker.source()) | |
| { | |
| diagnostic.set_fix(Fix::unsafe_edit(edit)); | |
| } else { | |
| diagnostic.set_fix(Fix::safe_edit(edit)); | |
| } | |
| } |
|
Thanks for contributing this rule. The code changes look good to me. I want to wait for updated ecosystem checks. I don't see why this PR should result in any new diagnostics other than TC006. |
MichaReiser
reviewed
Nov 22, 2024
| def f(): | ||
| import typing as t | ||
|
|
||
| t.cast(int, 3.0) # TC006 |
There was a problem hiding this comment.
Could we add a test where parts of the type are quoted?
Suggested change
| t.cast(int, 3.0) # TC006 | |
| t.cast(Literal["3.0", '3'], 3.0) # TC006 |
|
I'm a bit confused by the ecosystem checks. I understand that we run ruff exactly once and don't apply any fixes. That makes it unclear to me why there would be any changed diagnostics other than for TC006. |
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.
Now that
TCHhas been renamed toTCand the redirect fromTCH006toTCH010can no longer bite us, I've added an implementation for this very simple rule.Summary
TC006checks for non-string literal arguments totyping.castwhich adds unnecessary runtime overhead, since the function doesn't do anything at runtime.This PR has a very tiny overlap with my other PR for
TCH007/TCH008inflake8_type_checking/helpers.rsfor adding thequote_type_expressionfunction, but the two changes don't really depend on one another, so they can be merged in any order.Test Plan
cargo nextest run