Enum with `str` or `int` Mixin Breaking Change in Python 3.11 #100458

anze3db · 2022-12-23T11:53:54Z

Bug report

Looks like there was a breaking change with the way str and int mixins work with Enums in Python 3.11:

from enum import Enum


class Foo(str, Enum):
    BAR = "bar"

# Python 3.10
f"{Foo.BAR}"  # > bar

# Python 3.11
f"{Foo.BAR}"  # > Foo.BAR

The same goes for Enum classes with the int mixin.

In my project we were relying on Foo.BAR to return the enum value, so this change broke our code. We fixed it by replacing str Enum mixin with the newly added StrEnum class (thanks for that, it's exactly what we needed!).

I think reverting the breaking change would only introduce another breaking change so that's probably not the way to go. But maybe updating the whatsnew page and call out the change there could help people stumbling into this when doing the upgrade. I've found the existing point about this change in the release notes a little bit confusing and I have already opened a PR to try and clear it up a bit: #100387

I've also written a longer blog post about it here, and there has been some lively discussion in r/python.

Your environment

CPython versions tested on: 3.11.0, 3.11.1
Operating system and architecture: MacOS, Ubuntu 22.04

Linked PRs

The text was updated successfully, but these errors were encountered:

JosephSBoyle · 2022-12-25T20:01:47Z

@anze3db StrEnum was added in 3.11, does that work as a 'slot in' replacement for your use case?

docs: https://docs.python.org/3.11/library/enum.html#enum.StrEnum

anze3db · 2022-12-27T12:12:44Z

@JosephSBoyle yes, we replaced the str mixin with StrEnum to fix this on our end. If we could let people know about this breaking change in the what's new docs it would save me a lot of head scratching, especially since the current note about this change seems wrong (see my attempt of at least making it a bit more accurate: #100387)

JosephSBoyle · 2022-12-27T14:34:12Z

Coincidentally I've also used the mixin approach you describe in professional projects, which suggests that this use is at the very least not uncommon.

As such it makes sense that the docs also suggest a way to achieve the old behaviour, like you say @anze3db. I've added a small suggestion to your PR; hopefully that will help resolve things for others in the same position!

anze3db · 2022-12-27T15:08:43Z

Thank you! The text that you added would have helped me a lot when I was figuring out how to fix this 👍

…whatsnew/3.11.rst (GH-100387) Co-authored-by: JosephSBoyle <48555120+JosephSBoyle@users.noreply.github.com> Co-authored-by: Ethan Furman <ethan@stoneleaf.us>

…n the whatsnew/3.11.rst (pythonGH-100387) (cherry picked from commit e665563) Co-authored-by: Anže Pečar <anze@pecar.me> Co-authored-by: JosephSBoyle <48555120+JosephSBoyle@users.noreply.github.com> Co-authored-by: Ethan Furman <ethan@stoneleaf.us>

…in the whatsnew/3.11.rst (GH-100387) (GH-104060) Co-authored-by: Anže Pečar <anze@pecar.me> Co-authored-by: JosephSBoyle <48555120+JosephSBoyle@users.noreply.github.com> Co-authored-by: Ethan Furman <ethan@stoneleaf.us>

* main: (463 commits) pythongh-104057: Fix direct invocation of test_super (python#104064) pythongh-87092: Expose assembler to unit tests (python#103988) pythongh-97696: asyncio eager tasks factory (python#102853) pythongh-84436: Immortalize in _PyStructSequence_InitBuiltinWithFlags() (pythongh-104054) pythongh-104057: Fix direct invocation of test_module (pythonGH-104059) pythongh-100458: Clarify Enum.__format__() change of mixed-in types in the whatsnew/3.11.rst (pythonGH-100387) pythongh-104018: disallow "z" format specifier in %-format of byte strings (pythonGH-104033) pythongh-104016: Fixed off by 1 error in f string tokenizer (python#104047) pythonGH-103629: Update Unpack's repr in compliance with PEP 692 (python#104048) pythongh-102799: replace sys.exc_info by sys.exception in inspect and traceback modules (python#104032) Fix typo in "expected" word in few source files (python#104034) pythongh-103824: fix use-after-free error in Parser/tokenizer.c (python#103993) pythongh-104035: Do not ignore user-defined `__{get,set}state__` in slotted frozen dataclasses (python#104041) pythongh-104028: Reduce object creation while calling callback function from gc (pythongh-104030) pythongh-104036: Fix direct invocation of test_typing (python#104037) pythongh-102213: Optimize the performance of `__getattr__` (pythonGH-103761) pythongh-103895: Improve how invalid `Exception.__notes__` are displayed (python#103897) Adjust expression from `==` to `!=` in alignment with the meaning of the paragraph. (pythonGH-104021) pythongh-88496: Fix IDLE test hang on macOS (python#104025) Improve int test coverage (python#104024) ...

…m.KEY, which works on Python<3.11 but broke in 3.11 (see: python/cpython#100458)

* Pin transient urllib3 dependency to unbreak requests==2.30 * Pin to requests-toolbelt>=1 instead of pinning transient urllib3 * Add back importlib-metadata dependency * Allow Python 3.11 and add version to CI matrix * Pin urllib3 per requests issue recommendation, leave TODO * Pin transient urllib3 dependency to unbreak requests==2.30 * Pin to requests-toolbelt>=1 instead of pinning transient urllib3 * Add back importlib-metadata dependency * Tediously update all enum usages to use Enum.KEY.value instead of Enum.KEY, which works on Python<3.11 but broke in 3.11 (see: python/cpython#100458) * Move FR-specific upload_image_chips to kolena.fr._utils; remove kolena.fr._consts; rename some already-hidden classes to remove leading underscore (already in underscored files) * Revert {_=>}BatchedLoader diff, this PR is not the place for that * Start updating integration tests with new description edit semantics * Add missing pytest-depends dev dependency * Fix FR test__edit__reset * Assert description update without version update * Unbreak upload_image_chips after move * Unbreak FR test suite test__load by comparing data to data * Remove bad comparison

python/cpython#100458

jkbrzt · 2023-06-05T08:46:16Z

Also, str(HTTPStatus.OK) now returns '200' instead of 'HTTPStatus.OK'. Workaround:

from enum import Enum
from http import HTTPStatus

HTTPStatus.__str__ = Enum.__str__

BREAKING CHANGE: class Type(str, Enum) --> class Type(StrEnum) python/cpython#100458

hauntsaninja · 2023-09-07T06:29:19Z

Improving the What's New documentation was a good call, thank you! While I also found this needlessly breaking when updating my work codebase, I don't think there's anything left to be done here.

* updated configurations * fixed typo * added more info in error message * added support for general arithmetic expression * updated console calculator * switch from if-else to match-case * fix and skip mypy problems * pre-commit autoupdate * updated pyproject formatting * fixed failure tests for updated types * support negative numbers * refactor to reduce code complexity * added new test * added new test for wrong sub-parser use * formatted stub files with isort and black * updated readme * pre-commit autoupdate * updated sphinx docs * address PTC-W0063 detected by DeepSource * address enum str mixin formatting breaking change Ref. python/cpython#100458. * rename function * updated docstring * split infix to postfix conversion * skipped few lines from coverage * changed module docstring * removed unnecessary check * avoided list index out of range * improved error messages * added more tests * skip PY-R1000 detected by DeepSource * fixed typo * moved coverage skip to cover conditional block * skipped coverage for safety block * updated codecov configuration

I initially thought this was somehow a problem with fluent but it turned out to be a change in how to do string enums in python 3.11. python/cpython#100458 https://docs.python.org/3.11/library/enum.html#enum.StrEnum

* fixed issues with localization in python after 3.11 upgrade I initially thought this was somehow a problem with fluent but it turned out to be a change in how to do string enums in python 3.11. python/cpython#100458 https://docs.python.org/3.11/library/enum.html#enum.StrEnum * fixed typo

Fix python/cpython#100458 commit-id:f0b690de

Fix python/cpython#100458 Fix a pandas incompatibility commit-id:f0b690de

For more info, see python/cpython#100458

in 3.11 these f strings change for the enum python/cpython#100458 so just do `.value` ## How I Tested These Changes bk passes

another place effected by python/cpython#100458 the string `<GraphQLWS.PROTOCOL: 'graphql-ws'>` was being sent instead of `graphql-ws` ## How I Tested These Changes added assert to test that would have caught this

As per python/cpython#100458

Changes made: * Replace usage of Enum plus str mixin with StrEnum, as per python/cpython#100458

Changes made: * Replace usage of Enum plus str mixin with StrEnum, as per python/cpython#100458 * Sync "typing_extensions" version between requirements.txt and pyproject.toml

anze3db added the type-bug An unexpected behavior, bug, or error label Dec 23, 2022

bedevere-bot mentioned this issue Dec 23, 2022

gh-100458: Clarify Enum.__format__() change of mixed-in types in the whatsnew/3.11.rst #100387

Merged

AlexWaygood assigned ethanfurman Dec 23, 2022

AlexWaygood added docs Documentation in the Doc dir 3.11 only security fixes labels Dec 23, 2022

themattmorris mentioned this issue Apr 14, 2023

Make Extra a literal pydantic/pydantic#5431

Merged

gabrielmbmb mentioned this issue Apr 24, 2023

feat: add v1 enpoint to set Response status argilla-io/argilla#2756

Closed

14 tasks

bedevere-bot mentioned this issue May 1, 2023

[3.11] gh-100458: Clarify Enum.__format__() change of mixed-in types in the whatsnew/3.11.rst (GH-100387) #104060

Merged

gordonhart added a commit to kolenaIO/kolena that referenced this issue May 10, 2023

Tediously update all enum usages to use Enum.KEY.value instead of Enu…

3e9baba

…m.KEY, which works on Python<3.11 but broke in 3.11 (see: python/cpython#100458)

gordonhart mentioned this issue May 10, 2023

Support Python 3.11 kolenaIO/kolena#7

Merged

taro-kayo added a commit to taro-kayo/statelint that referenced this issue May 27, 2023

fix: Enum with str or int Mixin Breaking Change in Python 3.11

0ce5d2e

python/cpython#100458

taro-kayo added a commit to taro-kayo/statelint that referenced this issue May 27, 2023

fix: Enum with str or int Mixin Breaking Change in Python 3.11

8183604

python/cpython#100458

irataxy mentioned this issue Jun 27, 2023

fix: broken tests due to str(enum) changes in Python 3.11 GoogleCloudPlatform/python-docs-samples#10323

Merged

1 task

bebound mentioned this issue Aug 4, 2023

[Packaging] Support Python 3.11 Azure/azure-cli#26923

Merged

3 tasks

This was referenced Aug 30, 2023

feat: Py3.11 qw-in/graphql-codegen-pydantic#19

Closed

feat: changes for python 3.11 kraussmaffei/graphql-codegen-pydantic#12

Merged

maerzd added a commit to kraussmaffei/graphql-codegen-pydantic that referenced this issue Aug 30, 2023

feat: changes for python 3.11 (#12)

e21e066

BREAKING CHANGE: class Type(str, Enum) --> class Type(StrEnum) python/cpython#100458

maerzd added a commit to kraussmaffei/graphql-codegen-pydantic that referenced this issue Aug 30, 2023

feat: changes for python 3.11

b544468

BREAKING CHANGE: class Type(str, Enum) --> class Type(StrEnum) python/cpython#100458

kamoo1 mentioned this issue Sep 3, 2023

'Name or Service not known' when running kamoo1/Kamoo-s-TSM-App#37

Closed

sandalwoodbox mentioned this issue Nov 26, 2023

fixed issues with localization in python after 3.11 upgrade FanvidDB/fanviddb-server#131

Merged

dreinsch mentioned this issue Nov 27, 2023

Crash at startup with Python 3.11 interactive-sonification/sc3nb#18

Closed

RobertCraigie mentioned this issue Nov 30, 2023

Consistent enum formatting in 3.11+ RobertCraigie/prisma-client-py#845

Closed

larsevj mentioned this issue Nov 30, 2023

Make webviz-ert compatible with python3.11 equinor/webviz-ert#449

Merged

1 task

dhalperi added a commit to batfish/pybatfish that referenced this issue Dec 16, 2023

CI: try with 3.11 and 3.12

9db24ea

Fix python/cpython#100458 commit-id:f0b690de

dhalperi mentioned this issue Dec 16, 2023

CI: try with 3.11 and 3.12 batfish/pybatfish#902

Merged

dhalperi added a commit to batfish/pybatfish that referenced this issue Dec 16, 2023

CI: try with 3.11 and 3.12

c772cba

Fix python/cpython#100458 Fix a pandas incompatibility commit-id:f0b690de

dhalperi added a commit to batfish/pybatfish that referenced this issue Dec 16, 2023

CI: try with 3.11 and 3.12

9a00c1a

Fix python/cpython#100458 Fix a pandas incompatibility commit-id:f0b690de

dhalperi added a commit to batfish/pybatfish that referenced this issue Dec 16, 2023

CI: try with 3.11 and 3.12

5184595

Fix python/cpython#100458 Fix a pandas incompatibility commit-id:f0b690de

dhalperi added a commit to batfish/pybatfish that referenced this issue Dec 16, 2023

CI: try with 3.11 and 3.12

2274fd9

Fix python/cpython#100458 Fix a pandas incompatibility commit-id:f0b690de

dhalperi added a commit to batfish/pybatfish that referenced this issue Dec 16, 2023

CI: try with 3.11 and 3.12

d5d54df

Fix python/cpython#100458 Fix a pandas incompatibility commit-id:f0b690de

dhalperi added a commit to batfish/pybatfish that referenced this issue Dec 16, 2023

Update and add support for 3.11 and 3.12 (#902)

e238298

Fix python/cpython#100458 Fix a pandas incompatibility commit-id:f0b690de

sanjacob added a commit to sanjacob/bblearn that referenced this issue Jan 8, 2024

Fix issue with enum test caused by breaking change in cpython

5c57bd1

For more info, see python/cpython#100458

alangenfeld mentioned this issue Jan 9, 2024

[dagster-helm] 3.11 str enum compat dagster-io/dagster#19113

Merged

alangenfeld added a commit to dagster-io/dagster that referenced this issue Jan 9, 2024

[dagster-helm] 3.11 str enum compat (#19113)

c98cae5

in 3.11 these f strings change for the enum python/cpython#100458 so just do `.value` ## How I Tested These Changes bk passes

alangenfeld mentioned this issue Jan 19, 2024

[dagster webserver] fix websockets on py3.11 dagster-io/dagster#19328

Merged

smackesey mentioned this issue Feb 16, 2024

Allow io manager keys to be str enums not just strs dagster-io/dagster#18778

Closed

katsuya mentioned this issue Mar 7, 2024

fix: broken search url argilla-io/argilla#4633

Closed

10 tasks

kuderr mentioned this issue Apr 14, 2024

Constants rework kuderr/netsome#5

Merged

awoimbee mentioned this issue Apr 24, 2024

Allow user to set Train/Validation/Test subset on training data ansys/pysimai#42

Merged

lqc added a commit to syncron-oss/mage-ai that referenced this issue Apr 25, 2024

Replace usage of Enum plus str mixin with StrEnum

7dfa7f7

As per python/cpython#100458

lqc pushed a commit to syncron-oss/mage-ai that referenced this issue Apr 25, 2024

Add support for Python 3.11

3bc2ad9

Changes made: * Replace usage of Enum plus str mixin with StrEnum, as per python/cpython#100458

lqc pushed a commit to syncron-oss/mage-ai that referenced this issue Apr 25, 2024

Add support for Python 3.11

06fba20

Changes made: * Replace usage of Enum plus str mixin with StrEnum, as per python/cpython#100458 * Sync "typing_extensions" version between requirements.txt and pyproject.toml

lqc pushed a commit to syncron-oss/mage-ai that referenced this issue Apr 26, 2024

Add support for Python 3.11

8ed0fc4

Changes made: * Replace usage of Enum plus str mixin with StrEnum, as per python/cpython#100458 * Sync "typing_extensions" version between requirements.txt and pyproject.toml

plars mentioned this issue May 21, 2024

Add a testflinger_common module with example usage canonical/testflinger#275

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enum with `str` or `int` Mixin Breaking Change in Python 3.11 #100458

Enum with `str` or `int` Mixin Breaking Change in Python 3.11 #100458

anze3db commented Dec 23, 2022 •

edited by bedevere-bot

JosephSBoyle commented Dec 25, 2022 •

edited

anze3db commented Dec 27, 2022

JosephSBoyle commented Dec 27, 2022

anze3db commented Dec 27, 2022

jkbrzt commented Jun 5, 2023

hauntsaninja commented Sep 7, 2023

Enum with str or int Mixin Breaking Change in Python 3.11 #100458

Enum with str or int Mixin Breaking Change in Python 3.11 #100458

Comments

anze3db commented Dec 23, 2022 • edited by bedevere-bot

Bug report

Your environment

Linked PRs

JosephSBoyle commented Dec 25, 2022 • edited

anze3db commented Dec 27, 2022

JosephSBoyle commented Dec 27, 2022

anze3db commented Dec 27, 2022

jkbrzt commented Jun 5, 2023

hauntsaninja commented Sep 7, 2023

Enum with `str` or `int` Mixin Breaking Change in Python 3.11 #100458

Enum with `str` or `int` Mixin Breaking Change in Python 3.11 #100458

anze3db commented Dec 23, 2022 •

edited by bedevere-bot

JosephSBoyle commented Dec 25, 2022 •

edited