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

[FastAPI] Avoid introducing invalid syntax in fix for fast-api-non-annotated-dependency (FAST002) #13133

Merged
merged 2 commits into from
Aug 28, 2024

Conversation

arkuhn
Copy link
Contributor

@arkuhn arkuhn commented Aug 28, 2024

Summary

  • Context: this rule swaps out default function argument values for type annotations
  • Problem: When this swap occurs after a default argument value is already present, the function signature is no longer valid python code
  • Fix: Track default arguments and do not recommend a fix if we hit this condition, making this fix only sometimes possible.

Fixes #12982

Addtl:

  • Breakout helper functions

Test Plan

# 3 new test cases demonstrating default value scenarios
cargo run -p ruff -- check crates/ruff_linter/resources/test/fixtures/fastapi/FAST002.py  --no-cache --preview --select FAST002

cargo test

  - Context: this rule swaps out default function argument values
for type annotations
  - Problem: When this swap occurs after a default argument value is
    already present, the function signature is no longer valid python
code (astral-sh#12982)
  - Fix: Track default arguments and bail if we hit this condition,
    making this fix only sometimes possible.
@arkuhn arkuhn force-pushed the akuhn/FAST002_autofix branch from eff5e04 to dc94dd4 Compare August 28, 2024 05:10
Copy link
Contributor

github-actions bot commented Aug 28, 2024

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

@AlexWaygood AlexWaygood self-assigned this Aug 28, 2024
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

Thanks! This seems like a reasonable fix to me

@AlexWaygood AlexWaygood changed the title [FAST002] fix - do not generate invalid args [FastAPI] Avoid introducing invalid syntax in fix for fast-api-non-annotated-dependency (FAST002) Aug 28, 2024
@AlexWaygood AlexWaygood added bug Something isn't working fixes Related to suggested fixes for violations labels Aug 28, 2024
@AlexWaygood AlexWaygood enabled auto-merge (squash) August 28, 2024 15:26
@AlexWaygood AlexWaygood merged commit df694ca into astral-sh:main Aug 28, 2024
17 checks passed
Copy link

codspeed-hq bot commented Aug 28, 2024

CodSpeed Performance Report

Merging #13133 will improve performances by 7.61%

Comparing arkuhn:akuhn/FAST002_autofix (8e2aaf3) with main (2e75cfb)

Summary

⚡ 1 improvements
✅ 31 untouched benchmarks

Benchmarks breakdown

Benchmark main arkuhn:akuhn/FAST002_autofix Change
linter/all-rules[numpy/globals.py] 784.7 µs 729.2 µs +7.61%

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working fixes Related to suggested fixes for violations
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FAST002] FastAPI dependency without Annotated unsafe fix error
2 participants