← 返回首页
gh-100458: Clarify Enum.__format__() change of mixed-in types in the whatsnew/3.11.rst by anze3db · Pull Request #100387 · python/cpython · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

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

Merged
ethanfurman merged 7 commits into
python:mainfrom
anze3db:main
May 1, 2023
Merged

gh-100458: Clarify Enum.__format__() change of mixed-in types in the whatsnew/3.11.rst#100387
ethanfurman merged 7 commits into
python:mainfrom
anze3db:main

Conversation

anze3db commented Dec 21, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor

Hey! 👋

Please correct me if I'm wrong, but the description of the change Enum.format() change in 3.11.rst doesn't seem accurate. The behavior in older Python versions was to return the member's value and not the member's key as is currently stated. Example code:

from enum import Enum class Foo(str, Enum): BAR = "baz" print("{}".format(Foo.BAR)) class Foo(int, Enum): BAR = 1 print("{}".format(Foo.BAR))

Running this on Python 3.10 prints:

bar 1

And not

BAR BAR

as the changelog states:

Changed Enum.format() (the default for format(), str.format() and f-strings) of enums with mixed-in types (e.g. int, str) to also include the class name in the output, not just the member’s key. This matches the existing behavior of enum.Enum.str(), returning e.g. 'AnEnum.MEMBER' for an enum AnEnum(str, Enum) instead of just 'MEMBER'.

I noticed this because we were using the str mixin with all Enum classes as a hack to get to the value without needing to write Foo.BAR.value 🫣 The new behavior in Python 3.11 broke our code and the current phrasing in the changelog makes it feel this was just a minor bugfix. Should this change be a bit more prominent since it can be a breaking change?

By the way, thank you for adding StrEnum, it's exactly what we needed!

PS: Not sure if this needs a GitHub issue number, it's not exactly a typo, but it's still a minor change. I'm happy to open an issue if needed. Issue linked below. Also let me know if I need to open the PR against any other branches as well. 🙇

bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Dec 21, 2022

ghost commented Dec 21, 2022 •
edited by ghost
Loading

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

anze3db mentioned this pull request Dec 23, 2022
Closed
anze3db changed the title Clarify Enum.__format__() change of mixed-in types in the whatsnew/3.11.rst gh-100458: Clarify Enum.__format__() change of mixed-in types in the whatsnew/3.11.rst Dec 23, 2022
JosephSBoyle reviewed Dec 27, 2022
View reviewed changes
Comment thread Doc/whatsnew/3.11.rst Outdated Show resolved Hide resolved

anze3db commented Dec 27, 2022

Copy link
Copy Markdown
Contributor Author

@JosephSBoyle thank you! I've added your changes. Let me know if there is anything else needed from my side. Should I also open a PR against the 3.11 branch?

anze3db requested a review from JosephSBoyle December 27, 2022 15:08
ethanfurman added 3.11 only security fixes 3.12 only security fixes labels Dec 27, 2022

ethanfurman commented Dec 27, 2022

Copy link
Copy Markdown
Member

@anze3db No need, once this is committed a backport PR will be automatically created.

AlexWaygood added the needs backport to 3.11 only security fixes label Dec 27, 2022

anze3db commented Jan 31, 2023

Copy link
Copy Markdown
Contributor Author

@JosephSBoyle there was more than a month of inactivity on this PR 😞 Anything I can do to help this getting merged?

JosephSBoyle commented Jan 31, 2023

Copy link
Copy Markdown
Contributor

Hi @anze3db, I'm not a maintainer so perhaps this is a better question for @AlexWaygood. If the assigned reviewer is busy perhaps another reviewer can be assigned.

AlexWaygood self-requested a review January 31, 2023 09:39

Bktero commented Mar 22, 2023 •
edited
Loading

Copy link
Copy Markdown

Will this PR finds its way to the next version of Python?

Further question: is this change documented here https://docs.python.org/3/library/enum.html ? I can't spot it...

ethanfurman requested changes Mar 22, 2023
View reviewed changes

ethanfurman left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

My apologies -- I didn't get the [Submit Review] button pressed.

Comment thread Doc/whatsnew/3.11.rst Outdated
(the default for :func:`format`, :meth:`str.format` and :term:`f-string`\s)
of enums with mixed-in types (e.g. :class:`int`, :class:`str`)
to also include the class name in the output, not just the member's key.
to include the class name and member key in the output, not the member's value.

ethanfurman Feb 1, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment
Suggested change
to include the class name and member key in the output, not the member's value.
to show the class name and member name in the output, instead of the member's value.

Comment thread Doc/whatsnew/3.11.rst Outdated
to also include the class name in the output, not just the member's key.
to include the class name and member key in the output, not the member's value.
This matches the existing behavior of :meth:`enum.Enum.__str__`,
returning e.g. ``'AnEnum.MEMBER'`` for an enum ``AnEnum(str, Enum)``

ethanfurman Feb 1, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment
Suggested change
returning e.g. ``'AnEnum.MEMBER'`` for an enum ``AnEnum(str, Enum)``
returning e.g. ``'AnEnum.MEMBER'`` for an enum ``AnEnum(str, Enum)``.

Comment thread Doc/whatsnew/3.11.rst Outdated
This matches the existing behavior of :meth:`enum.Enum.__str__`,
returning e.g. ``'AnEnum.MEMBER'`` for an enum ``AnEnum(str, Enum)``
instead of just ``'MEMBER'``.
instead of the member's value. Those wishing to keep the old formatting behavior

ethanfurman Feb 1, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment
Suggested change
instead of the member's value. Those wishing to keep the old formatting behavior
Those wishing to keep the old formatting behavior

bedevere-bot commented Mar 22, 2023

Copy link
Copy Markdown

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

AlexWaygood removed their request for review March 22, 2023 16:54

anze3db commented Mar 22, 2023

Copy link
Copy Markdown
Contributor Author

I have made the requested changes; please review again.

bedevere-bot commented Mar 22, 2023

Copy link
Copy Markdown

Thanks for making the requested changes!

@ethanfurman: please review the changes made to this pull request.

anze3db commented Apr 13, 2023

Copy link
Copy Markdown
Contributor Author

@ethanfurman just a friendly reminder to re-review this if you have the time, thanks!

ethanfurman reviewed Apr 18, 2023
View reviewed changes

ethanfurman left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Did some rewriting in an attempt to make it clearer.

Thoughts on the new changes?

ethanfurman merged commit e665563 into python:main May 1, 2023

miss-islington commented May 1, 2023

Copy link
Copy Markdown
Contributor

Thanks @anze3db for the PR, and @ethanfurman for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 1, 2023
pythongh-100458: Clarify Enum.__format__() change of mixed-in types i… …
ff58045
…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>

bedevere-bot commented May 1, 2023

Copy link
Copy Markdown

GH-104060 is a backport of this pull request to the 3.11 branch.

bedevere-bot removed the needs backport to 3.11 only security fixes label May 1, 2023
ethanfurman added a commit that referenced this pull request May 1, 2023
[3.11] gh-100458: Clarify Enum.__format__() change of mixed-in types … …
723aacb
…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>
carljm added a commit to carljm/cpython that referenced this pull request May 1, 2023
Merge branch 'main' into inlinecomp2 …
1274e2b
* 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) ...
This file contains hidden or 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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

ethanfurman ethanfurman approved these changes
+1 more reviewer
JosephSBoyle JosephSBoyle approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

ethanfurman

Labels

3.11 only security fixes 3.12 only security fixes docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

Footer

© 2026 GitHub, Inc.