Skip to content

gh-98298: [Enum] document ReprEnum, global_enum, and show_flag_values #98455

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

Merged
merged 4 commits into from
Oct 21, 2022
Merged

gh-98298: [Enum] document ReprEnum, global_enum, and show_flag_values #98455

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2e9a6c8
document ReprEnum, global_enum, and show_flag_values
ethanfurman Oct 19, 2022
25059f7
incorporate suggestions from CAM-Gerlach
ethanfurman Oct 20, 2022
ab04ae1
Merge branch 'main' into enum-whatsnew
ethanfurman Oct 20, 2022
5fabc78
Apply suggestions from code review
ethanfurman Oct 21, 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
48 changes: 47 additions & 1 deletion Doc/library/enum.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,11 @@ Module Contents
the bitwise operators without losing their :class:`IntFlag` membership.
:class:`IntFlag` members are also subclasses of :class:`int`. (`Notes`_)

:class:`ReprEnum`

Used by :class:`IntEnum`, :class:`StrEnum`, and :class:`IntFlag`
to keep the :class:`str() <str>` of the mixed-in type.

:class:`EnumCheck`

An enumeration with the values ``CONTINUOUS``, ``NAMED_FLAGS``, and
Expand Down Expand Up @@ -132,9 +137,20 @@ Module Contents

Do not make ``obj`` a member. Can be used as a decorator.

:func:`global_enum`

Modify the :class:`str() <str>` and :func:`repr` of an enum
to show its members as belonging to the module instead of its class.
Should only be used if the enum members will be exported to the
module global namespace.

:func:`show_flag_values`

Return a list of all power-of-two integers contained in a flag.


.. versionadded:: 3.6 ``Flag``, ``IntFlag``, ``auto``
.. versionadded:: 3.11 ``StrEnum``, ``EnumCheck``, ``FlagBoundary``, ``property``, ``member``, ``nonmember``
.. versionadded:: 3.11 ``StrEnum``, ``EnumCheck``, ``ReprEnum``, ``FlagBoundary``, ``property``, ``member``, ``nonmember``, ``global_enum``, ``show_flag_values``

---------------

Expand Down Expand Up @@ -573,6 +589,20 @@ Data Types
better support the *replacement of existing constants* use-case.
:meth:`__format__` was already :func:`int.__format__` for that same reason.

.. class:: ReprEnum

:class:`!ReprEum` uses the :meth:`repr() <Enum.__repr__>` of :class:`Enum`,
but the :class:`str() <str>` of the mixed-in data type:

* :meth:`!int.__str__` for :class:`IntEnum` and :class:`IntFlag`
* :meth:`!str.__str__` for :class:`StrEnum`

Inherit from :class:`!ReprEnum` to keep the :class:`str() <str> / :func:`format`
of the mixed-in data type instead of using the
:class:`Enum`-default :meth:`str() <Enum.__str__>`.


.. versionadded:: 3.11

.. class:: EnumCheck

Expand Down Expand Up @@ -808,6 +838,22 @@ Utilities and Decorators

.. versionadded:: 3.11

.. decorator:: global_enum

A decorator to change the :class:`str() <str>` and :func:`repr` of an enum
to show its members as belonging to the module instead of its class.
Should only be used when the enum members are exported
to the module global namespace (see :class:`re.RegexFlag` for an example).


.. versionadded:: 3.11

.. function:: show_flag_values(value)

Return a list of all power-of-two integers contained in a flag *value*.

.. versionadded:: 3.11

---------------

Notes
Expand Down