https://github.com/python/cpython/commit/39e69a7cd54d44c9061db89bb15c460d30fba7a6
commit: 39e69a7cd54d44c9061db89bb15c460d30fba7a6
branch: main
author: Md Rokibul Islam <[email protected]>
committer: ethanfurman <[email protected]>
date: 2024-12-19T15:38:42-08:00
summary:

gh-112328: Document EnumDict in docs and release notes (GH-121720)

Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) 
<[email protected]>
Co-authored-by: Ethan Furman <[email protected]>

files:
M Doc/library/enum.rst
M Doc/whatsnew/3.13.rst

diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst
index 16a9b0326e9f3d..51292a11f507c4 100644
--- a/Doc/library/enum.rst
+++ b/Doc/library/enum.rst
@@ -149,9 +149,14 @@ Module Contents
 
       Return a list of all power-of-two integers contained in a flag.
 
+   :class:`EnumDict`
+
+      A subclass of :class:`dict` for use when subclassing :class:`EnumType`.
+
 
 .. versionadded:: 3.6  ``Flag``, ``IntFlag``, ``auto``
 .. versionadded:: 3.11  ``StrEnum``, ``EnumCheck``, ``ReprEnum``, 
``FlagBoundary``, ``property``, ``member``, ``nonmember``, ``global_enum``, 
``show_flag_values``
+.. versionadded:: 3.14  ``EnumDict``
 
 ---------------
 
@@ -821,7 +826,17 @@ Data Types
          >>> KeepFlag(2**2 + 2**4)
          <KeepFlag.BLUE|16: 20>
 
-.. versionadded:: 3.11
+   .. versionadded:: 3.11
+
+.. class:: EnumDict
+
+   *EnumDict* is a subclass of :class:`dict` for use when subclassing 
:class:`EnumType`.
+
+   .. attribute:: EnumDict.member_names
+
+      Return list of member names.
+
+   .. versionadded:: 3.14
 
 ---------------
 
diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst
index 45cc1b5bad9b18..a291122aefc2ce 100644
--- a/Doc/whatsnew/3.13.rst
+++ b/Doc/whatsnew/3.13.rst
@@ -879,6 +879,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` to better support
+  subclassing :class:`~enum.EnumType`.
 
 fractions
 ---------

_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]

Reply via email to