From: Nicolas A. Oyarzabal <79150521+nicky-eng@users.noreply.github.com>
Date: Fri, 8 Mar 2024 19:22:17 +0000 (+0100)
Subject: gh-105535 Document potential performance trap during enum creation (GH-107119)
X-Git-Tag: v3.13.0a5~47
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=601f3a7b3391e9d219a8ec44a6c56d00ce584d2a;p=thirdparty%2FPython%2Fcpython.git

gh-105535 Document potential performance trap during enum creation (GH-107119)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
---

diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst
index 49bf40aa5a28..d84d9d9b4161 100644
--- a/Doc/library/enum.rst
+++ b/Doc/library/enum.rst
@@ -279,6 +279,8 @@ 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
@@ -286,6 +288,11 @@ Data Types
          appropriate value will be chosen for you.  See :class:`auto` for the
          details.
 
+         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._name_
 
       Name of the member.