Skip to content

gh-98250: Improve documentation about change to Enum.__format__ #98261

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

Closed
mdboom wants to merge 2 commits into from
Closed

gh-98250: Improve documentation about change to Enum.__format__ #98261

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3cd6e55
gh-98250: Improve documentation about change to Enum.__format__
mdboom Oct 14, 2022
b35a09a
Add note about `__format__` used in f-strings
mdboom Oct 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
gh-98250: Improve documentation about change to Enum.__format__
  • Loading branch information
@mdboom
mdboom committed Oct 14, 2022
commit 3cd6e5545165ecf3d098b6cee9a01613ea4878a9
5 changes: 5 additions & 0 deletions Doc/whatsnew/3.11.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -624,6 +624,11 @@ enum

* ``EnumMeta`` renamed to ``EnumType`` (``EnumMeta`` kept as alias).

* The output of ``Enum.__format__`` has changed to include both the enum name

@JelleZijlstra JelleZijlstra Oct 15, 2022

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.

Might be worth adding explicitly that this affects enums included in f-strings, since that may not be obvious to a lot of readers.

and the member name (e.g. ``Enum.MEMBER``). In 3.10 and earlier it only
included the member name (e.g. ``MEMBER``). To restore the new behavior,
inherit from a subclass of ``ReprEnum``, such as ``IntEnum`` or ``StrEnum``.

* ``StrEnum`` added -- enum members are and must be strings.

* ``ReprEnum`` added -- causes only the ``__repr__`` to be modified, not the
Expand Down