]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-112328: Document EnumDict in docs and release notes (GH-121720)
authorMd Rokibul Islam <rafi.promit@gmail.com>
Thu, 19 Dec 2024 23:38:42 +0000 (00:38 +0100)
committerGitHub <noreply@github.com>
Thu, 19 Dec 2024 23:38:42 +0000 (15:38 -0800)
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
Doc/library/enum.rst
Doc/whatsnew/3.13.rst

index 16a9b0326e9f3dd3767ba593cafcb94b2be9787c..51292a11f507c4fc4a3b2e100bf1740e575fc675 100644 (file)
@@ -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
 
 ---------------
 
index 45cc1b5bad9b18528b031015d7448af50cdfaf08..a291122aefc2ce1734f99e3799b3eedf4c871331 100644 (file)
@@ -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
 ---------