Skip to content

[pyupgrade] Don't introduce invalid syntax when upgrading old-style type aliases with parenthesized multiline values (UP040) - #16026

Merged
AlexWaygood merged 3 commits into
mainfrom
alex/up040
Feb 7, 2025
Merged

[pyupgrade] Don't introduce invalid syntax when upgrading old-style type aliases with parenthesized multiline values (UP040)#16026
AlexWaygood merged 3 commits into
mainfrom
alex/up040

Conversation

@AlexWaygood

@AlexWaygood AlexWaygood commented Feb 7, 2025

Copy link
Copy Markdown
Member

Summary

We previously autofixed this:

from typing import TypeAlias

T: TypeAlias = (
    int
    | str
)

to this:

type T = int
    | str

When we should be autofixing it to this:

type T = (
    int
    | str
)

This PR fixes the bug. Closes #16023

Test Plan

New fixture added that repros the issue on main.

@AlexWaygood AlexWaygood added bug Something isn't working fixes Related to suggested fixes for violations python312 Related to Python 3.12 labels Feb 7, 2025
@AlexWaygood AlexWaygood changed the title add failing test [pyupgrade] Don't introduce invalid syntax when upgrading old-style type aliases (UP040) Feb 7, 2025
@AlexWaygood AlexWaygood changed the title [pyupgrade] Don't introduce invalid syntax when upgrading old-style type aliases (UP040) [pyupgrade] Don't introduce invalid syntax when upgrading old-style type aliases with parenthesized multiline values (UP040) Feb 7, 2025
@AlexWaygood

AlexWaygood commented Feb 7, 2025

Copy link
Copy Markdown
Member Author

I think this is a small regression from #15840 (cc. @ntBre) -- totally one I should have caught in review, though!

@github-actions

github-actions Bot commented Feb 7, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

MichaReiser
MichaReiser approved these changes Feb 7, 2025
View reviewed changes
Comment thread crates/ruff_linter/src/rules/pyupgrade/rules/pep695/non_pep695_type_alias.rs Outdated
InSyncWithFoo
InSyncWithFoo reviewed Feb 7, 2025
View reviewed changes
Comment thread crates/ruff_linter/resources/test/fixtures/pyupgrade/UP040.py
T: TypeAlias = (
int
| str
)

@InSyncWithFoo InSyncWithFoo Feb 7, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This might be a good test case to add:

T: TypeAlias = (  # This comment should not make the fix unsafe
	int | str
)

@AlexWaygood AlexWaygood Feb 7, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Thanks! However, all fixes for this rule are unsafe (because you can't use PEP-695 type aliases as the second argument in isinstance() calls, whereas you can with old-style type aliases that use TypeAlias)

@InSyncWithFoo InSyncWithFoo Feb 7, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

However, all fixes for this rule are unsafe

Aren't they safe in stubs?

@AlexWaygood AlexWaygood Feb 7, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Aren't they safe in stubs?

hmm, good point. Want to make a followup PR?

@InSyncWithFoo InSyncWithFoo Feb 7, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sure. I'm ready whenever you are.

@ntBre

ntBre commented Feb 7, 2025

Copy link
Copy Markdown
Contributor

Sorry about that! Thanks for the quick fix! I don't have anything to add on top of the other reviews, LGTM.

@AlexWaygood
AlexWaygood enabled auto-merge (squash) February 7, 2025 17:01
@AlexWaygood
AlexWaygood merged commit efa8a3d into main Feb 7, 2025
@AlexWaygood
AlexWaygood deleted the alex/up040 branch February 7, 2025 17:05
@InSyncWithFoo InSyncWithFoo mentioned this pull request Feb 7, 2025
Merged
dylwil3 added a commit that referenced this pull request Feb 7, 2025
@InSyncWithFoo @dylwil3
[pyupgrade] Comments within parenthesized value ranges should not a…
a29009e 
…ffect applicability (`UP040`) (#16027)

## Summary

Follow-up to #16026.

Previously, the fix for this would be marked as unsafe, even though all
comments are preserved:

```python
# .pyi
T: TypeAlias = (  # Comment
	int | str
)
```

Now it is safe: comments within the parenthesized range no longer affect
applicability.

## Test Plan

`cargo nextest run` and `cargo insta test`.

---------

Co-authored-by: Dylan <53534755+dylwil3@users.noreply.github.com>
@BrewTestBot BrewTestBot mentioned this pull request Feb 10, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MichaReiser MichaReiser MichaReiser approved these changes
+1 more reviewer
@InSyncWithFoo InSyncWithFoo InSyncWithFoo left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

bug Something isn't working fixes Related to suggested fixes for violations python312 Related to Python 3.12

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

UP040 fixes introduce a syntax error

4 participants

@AlexWaygood @ntBre @MichaReiser @InSyncWithFoo