8000 gh-112328: Make EnumDict usable on its own and document it by encukou · Pull Request #123669 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-112328: Make EnumDict usable on its own and document it #123669

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 13 commits into from
Dec 20, 2024
Merged

gh-112328: Make EnumDict usable on its own and document it #123669

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
d00adac
Document EnumDict in docs and release notes
u2rafi Jul 14, 2024
3bff0b9
Restore deleted EnumType
u2rafi Jul 14, 2024
11e2fd1
Update Doc/library/enum.rst
u2rafi Jul 16, 2024
e8c368e
Update description
u2rafi Jul 28, 2024
05ea9bd
Put EnumDict docs on the buttom to de-emphasize the class
encukou Sep 4, 2024
3e88296
Add a versionadded entry, and properly indent a previous one
encukou Sep 4, 2024
162ebf0
Reword the documentation
encukou Sep 4, 2024
5d9c81b
Allow usage of EnumDict without setting a private attr. Add tests.
encukou Sep 4, 2024
361c9ca
Merge in the main branch
encukou Sep 4, 2024
d41afb0
Merge branch 'main' into enumdict-docs-112328
ethanfurman Dec 4, 2024
a33aa0c
Merge branch 'main' into enumdict-docs-112328
ethanfurman Dec 19, 2024
694d8f7
updates
ethanfurman Dec 20, 2024
9d6908c
more fixes
ethanfurman Dec 20, 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
Next Next commit
Document EnumDict in docs and release notes
  • Loading branch information
@u2rafi
u2rafi committed Jul 14, 2024
commit d00adac946aa136019f7c7ee68c0a230c4179111
20 changes: 19 additions & 1 deletion Doc/library/enum.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,11 @@
Module Contents
---------------

:class:`EnumDict`

An enum class :class:`dict` that tracks order and enforces unique member names.

:class:`EnumType`

Check warning on line 71 in Doc/library/enum.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

py:class reference target not found: EnumType

The ``type`` for Enum and its subclasses.

Expand Down Expand Up @@ -159,7 +163,21 @@
----------


.. class:: EnumType
.. class:: EnumDict

*EnumDict* is used by *EnumType* to keep track of the enum member orders and prevent reusing the member names.

.. attribute:: EnumDict.member_names

Return list of member names.

.. method:: EnumDict.__setitem__(self, key, value)

Set any item as an enum member that is not dundered and not a descriptor.

.. method:: EnumDict.update(self, members, **more_members)

Update the dictionary from the given iterable or dictionary members and more_members.

*EnumType* is the :term:`metaclass` for *enum* enumerations. It is possible
to subclass *EnumType* -- see :ref:`Subclassing EnumType <enumtype-examples>`
Expand Down
5 changes: 5 additions & 0 deletions Doc/whatsnew/3.13.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -742,6 +742,11 @@ email
(Contributed by Thomas Dwyer and Victor Stinner for :gh:`102988` to improve
the :cve:`2023-27043` fix.)

enum
----

* :class:`~enum.EnumDict` has been made public in :mod:`enum`.

fractions
---------

Expand Down
Loading
0