Skip to content

gh-105535 Document potential performance trap during enum creation #107119

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
ethanfurman merged 11 commits into from
Mar 8, 2024
Merged

gh-105535 Document potential performance trap during enum creation #107119

Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
d433f21
gh-105535 Document potential performance trap during enum creation
nicky-eng Jul 23, 2023
981eaca
gh-105535: Add warning about quadratical growth
nicky-eng Jul 23, 2023
6275352
Update Doc/library/enum.rst
ethanfurman Jul 24, 2023
94eba9a
Update Doc/library/enum.rst
ethanfurman Jul 24, 2023
c89ebd4
Update Doc/library/enum.rst
ethanfurman Jul 25, 2023
8b3a9dd
Merge branch 'main' into fix-issue-105535
nicky-eng Jul 29, 2023
c8c74cd
Update Doc/library/enum.rst
ethanfurman Mar 4, 2024
ee2a962
Merge branch 'main' into fix-issue-105535
ethanfurman Mar 4, 2024
f405180
remove trailing whitespace
ethanfurman Mar 4, 2024
baf05a0
re-add sunder versions of name and value
ethanfurman Mar 5, 2024
43cc68c
Update Doc/library/enum.rst
ethanfurman Mar 5, 2024
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
13 changes: 6 additions & 7 deletions Doc/library/enum.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,20 +279,19 @@ Data Types
>>> Color.RED.value
1

Value of the member, can be set in :meth:`~object.__new__`.

.. note:: Enum member values

Member values can be anything: :class:`int`, :class:`str`, etc. If
the exact value is unimportant you may use :class:`auto` instances and an
appropriate value will be chosen for you. See :class:`auto` for the
details.

.. attribute:: Enum._name_

Name of the member.

.. attribute:: Enum._value_

Value of the member, can be set in :meth:`~object.__new__`.
While mutable/unhashable values, such as :class:`dict`, :class:`list` or
a mutable :class:`~dataclasses.dataclass`, can be used, they will have a
quadratic performance impact during creation relative to the
total number of mutable/unhashable values in the enum.

.. attribute:: Enum._order_

Expand Down