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.

Sign up for GitHub

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

Jump to bottom

pyupgrade rule: upgrading str, Enum to StrEnum #9569

Closed
jamesbraza opened this issue Jan 17, 2024 · 5 comments · Fixed by #10713
Closed

pyupgrade rule: upgrading str, Enum to StrEnum #9569

jamesbraza opened this issue Jan 17, 2024 · 5 comments · Fixed by #10713
Assignees
@arferreira
Labels
good first issue Good for newcomers rule Implementing or modifying a lint rule

Comments

@jamesbraza
Copy link
Contributor

Since Python 3.11 there are now StrEnum and IntEnum:

from enum import Enum, IntEnum, StrEnum

class Foo(str, Enum):  ...  # Python<3.11
class Foo(StrEnum):  ...  # Python>=3.11

class Bar(int, Enum): ...  # Python<3.11
class Bar(IntEnum): ...  # Python>=3.11

pyupgrade can be used to suggest this change.

However, this request was rejected in pyupgrade itself here: asottile/pyupgrade#779. Apparently they're not identical in behavior. Luckily, ruff has a concept of safe vs unsafe, so I think ruff can actually implement this rule.

The request here is for ruff to suggest this upgrade as an unsafe fix, ideally with autofix support.
@zanieb
Copy link
Member

zanieb commented Jan 17, 2024

Sounds good to me!

@zanieb zanieb added good first issue Good for newcomers rule Implementing or modifying a lint rule labels Jan 17, 2024
@bswck
Copy link
Contributor

bswck commented Jan 17, 2024 •
edited
Loading

Side note here: IntEnum has already been available since Python 3.4 and enum being introduced. Only StrEnum came in 3.11.

@arferreira
Copy link

Hey @zanieb, is this issue active? Can I try to upgrade this?

@charliermarsh
Copy link
Member

Go for it @arferreira!

@dhruvmanila
Copy link
Member

Relevant discussion: #3867

@Warchant Warchant mentioned this issue Apr 1, 2024
Merged
charliermarsh pushed a commit that referenced this issue Apr 6, 2024
@Warchant
[pyupgrade] Replace str, Enum with StrEnum (UP042) (#10713)
b45fd61 
## Summary

Add new rule `pyupgrade - UP042` (I picked next available number).
Closes #3867
Closes #9569

It should warn + provide a fix `class A(str, Enum)` -> `class
A(StrEnum)` for py311+.

## Test Plan

Added UP042.py test.

## Notes

I did not find a way to call `remove_argument` 2 times consecutively, so
the automatic fixing works only for classes that inherit exactly `str,
Enum` (regardless of the order).

I also plan to extend this rule to support IntEnum in next PR.
Glyphack pushed a commit to Glyphack/ruff that referenced this issue Apr 12, 2024
@Warchant @Glyphack
[pyupgrade] Replace str, Enum with StrEnum (UP042) (astral-sh…
325963b 
…#10713)

## Summary

Add new rule `pyupgrade - UP042` (I picked next available number).
Closes astral-sh#3867
Closes astral-sh#9569

It should warn + provide a fix `class A(str, Enum)` -> `class
A(StrEnum)` for py311+.

## Test Plan

Added UP042.py test.

## Notes

I did not find a way to call `remove_argument` 2 times consecutively, so
the automatic fixing works only for classes that inherit exactly `str,
Enum` (regardless of the order).

I also plan to extend this rule to support IntEnum in next PR.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@arferreira arferreira

Labels
good first issue Good for newcomers rule Implementing or modifying a lint rule
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[pyupgrade] Replace str,Enum with StrEnum UP042 Warchant/ruff
6 participants
@charliermarsh @zanieb @arferreira @jamesbraza @bswck @dhruvmanila