Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

gh-118650: Document `Enum._repr_*` reservation exclusion (GH-118698)

This commit is contained in:
chrysn 2024-05-07 20:11:18 +02:00 committed by GitHub
parent b9caa0977c
commit f58833ebf8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Doc/library/enum.rst
View File

@ -861,9 +861,15 @@ Supported ``_sunder_`` names
For :class:`Flag` classes the next value chosen will be the next highest For :class:`Flag` classes the next value chosen will be the next highest
power-of-two. power-of-two.
- While ``_sunder_`` names are generally reserved for the further development
of the :class:`Enum` class and can not be used, some are explicitly allowed:
- ``_repr_*`` (e.g. ``_repr_html_``), as used in `IPython's rich display`_
.. versionadded:: 3.6 ``_missing_``, ``_order_``, ``_generate_next_value_`` .. versionadded:: 3.6 ``_missing_``, ``_order_``, ``_generate_next_value_``
.. versionadded:: 3.7 ``_ignore_`` .. versionadded:: 3.7 ``_ignore_``
.. versionadded:: 3.13 ``_add_alias_``, ``_add_value_alias_`` .. versionadded:: 3.13 ``_add_alias_``, ``_add_value_alias_``, ``_repr_*``
.. _`IPython's rich display`: https://ipython.readthedocs.io/en/stable/config/integrating.html#rich-display
--------------- ---------------