Skip to content

Commit

Permalink
pythongh-100458: Clarify Enum.__format__() change of mixed-in types i…
Browse files Browse the repository at this point in the history
…n the whatsnew/3.11.rst (pythonGH-100387)

Co-authored-by: JosephSBoyle <[email protected]>
Co-authored-by: Ethan Furman <[email protected]>
  • Loading branch information
3 people authored May 1, 2023
1 parent 3ed8c88 commit e665563
Showing 1 changed file with 5 additions and 13 deletions.
18 changes: 5 additions & 13 deletions Doc/whatsnew/3.11.rst
Original file line number Diff line number Diff line change
Expand Up @@ -666,19 +666,11 @@ enum
for :meth:`~object.__str__` and :meth:`~object.__format__`
(used by :func:`str`, :func:`format` and :term:`f-string`\s).

* Changed :class:`~enum.IntEnum`, :class:`~enum.IntFlag` and :class:`~enum.StrEnum`
to now inherit from :class:`~enum.ReprEnum`,
so their :func:`str` output now matches :func:`format`
(both ``str(AnIntEnum.ONE)`` and ``format(AnIntEnum.ONE)`` return ``'1'``,
whereas before ``str(AnIntEnum.ONE)`` returned ``'AnIntEnum.ONE'``.

* Changed :meth:`Enum.__format__() <enum.Enum.__format__>`
(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.
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'``.
* Changed :meth:`Enum.__format__() <enum.Enum.__format__>` (the default for
:func:`format`, :meth:`str.format` and :term:`f-string`\s) to always produce
the same result as :meth:`Enum.__str__()`: for enums inheriting from
:class:`~enum.ReprEnum` it will be the member's value; for all other enums
it will be the enum and member name (e.g. ``Color.RED``).

* Added a new *boundary* class parameter to :class:`~enum.Flag` enums
and the :class:`~enum.FlagBoundary` enum with its options,
Expand Down

0 comments on commit e665563

Please sign in to comment.