0d9d56c4e4
gh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs ( #124480 )
2024-09-25 19:29:58 +00:00
103a0470e3
gh-123492: Remove unnecessary `:func:` parentheses ( #123493 )
2024-08-30 14:34:09 +03:00
ed5ae6c4d7
gh-118820: Zero-valued flag enum has no name (GH-118848)
...
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-06-19 13:09:53 -07:00
a26d27e7ee
Update the documentation howto index page and group docs into 3 logical sections (GH-119366)
...
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2024-06-17 16:37:33 +02:00
72d2d0f10d
gh-114803: Mention that `@dataclass` should not be applied on enums (GH-114891)
...
Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2024-02-03 13:55:38 -08:00
de6bca9564
gh-112328: [Enum] Make some private attributes public. (GH-112514)
...
* [Enum] Make some private attributes public.
- ``_EnumDict`` --> ``EnumDict``
- ``EnumDict._member_names`` --> ``EnumDict.member_names``
- ``Enum._add_alias_``
- ``Enum._add_value_alias_``
---------
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-12-05 08:27:36 -08:00
f9e6ce0395
[Enum] update class creation for RuntimeError changes (GH-111815)
2023-11-28 20:40:12 -08:00
7d21e3d5ee
gh-111895: Convert definition list to bullet list for readability on mobile ( #111898 )
...
Convert definition list to bullet list for readability on mobile
2023-11-09 20:50:27 +02:00
c4dc5a6ae8
gh-111181: Fix enum doctests (GH-111180)
...
Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2023-10-30 12:56:29 -07:00
718391f475
gh-110631: Fix reST indentation ( #110724 )
...
* Fix wrong indentation in the other dirs.
* Fix more wrong indentation.
2023-10-11 22:43:03 +02:00
d48760b2f1
gh-108682: [Enum] raise TypeError if super().__new__ called in custom __new__ (GH-108704)
...
When overriding the `__new__` method of an enum, the underlying data type should be created directly; i.e. .
member = object.__new__(cls)
member = int.__new__(cls, value)
member = str.__new__(cls, value)
Calling `super().__new__()` finds the lookup version of `Enum.__new__`, and will now raise an exception when detected.
2023-08-31 12:45:12 -07:00
4ff5690e59
gh-105332: [Enum] Fix unpickling flags in edge-cases (GH-105348)
...
* revert enum pickling from by-name to by-value
Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2023-06-08 11:40:15 -07:00
700ec657c8
gh-103596: [Enum] do not shadow mixed-in methods/attributes (GH-103600)
...
For example:
class Book(StrEnum):
title = auto()
author = auto()
desc = auto()
Book.author.desc is Book.desc
but
Book.author.title() == 'Author'
is commonly expected. Using upper-case member names avoids this confusion and possible performance impacts.
Co-authored-by: samypr100 <3933065+samypr100@users.noreply.github.com>
2023-04-18 16:19:23 -07:00
a6f95941a3
gh-103479: [Enum] require __new__ to be considered a data type (GH-103495)
...
a mixin must either have a __new__ method, or be a dataclass, to be interpreted as a data-type
2023-04-13 08:31:03 -07:00
4ec8dd10bd
gh-93910: [Enum] remove member.member deprecation (GH-103236)
...
i.e. Color.RED.BLUE is now officially supported.
2023-04-05 17:33:52 -07:00
810d365b5e
gh-103056: [Enum] use staticmethod decorator for _gnv_ (GH-103231)
...
_gnv_ --> _generate_next_value_
2023-04-03 17:47:40 -07:00
5ffc1e5a21
gh-98298, gh-74730: [Enum] update docs (GH-103163)
...
fix FlagBoundary statements
add warning about reloading modules and enum identity
2023-04-03 14:57:42 -07:00
286e3c76a9
gh-99087: Add missing newline for prompts in docs (GH-98993)
...
Add newline for prompts so copying to REPL does not cause errors.
2022-12-08 19:31:19 -08:00
679efbb080
gh-94943: [Enum] improve repr() when inheriting from a dataclass (GH-99740)
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-12-06 13:43:41 -08:00
73a921b070
gh-99304: [Enum] clarify what constitutes a flag alias (GH-99395)
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-11-12 10:39:47 -08:00
b3bd69c1bf
[Enum] Typo: fix DuplicateFreeEnum example docs (GH-99265)
2022-11-08 16:39:56 -08:00
fa2d43e518
Docs: Fix backtick errors found by sphinx-lint ( #97998 )
...
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-10-06 18:01:30 -07:00
4e704d7847
gh-95077: [Enum] add code-based deprecation warnings for member.member access (GH-95083)
...
* issue deprecation warning for member.member access
* always store member property in current class
* remove __getattr__
2022-07-25 11:05:10 -07:00
bcafab849e
[doc]: Spotted errors while working on rstlint. (GH-30879)
...
Also ignored some `make suspicious` false positives while assuring
true positives were properly seen by rstlint.
2022-01-27 08:57:43 +01:00
83d544b929
bpo-40066: [Enum] skip failing doc test (GH-30637)
2022-01-17 07:18:13 -08:00
42a64c03ec
Revert "bpo-40066: [Enum] update str() and format() output (GH-30582)" (GH-30632)
...
This reverts commit acf7403f9b
2022-01-17 13:58:40 +01:00
acf7403f9b
bpo-40066: [Enum] update str() and format() output (GH-30582)
...
Undo rejected PEP-663 changes:
- restore `repr()` to its 3.10 status
- restore `str()` to its 3.10 status
New changes:
- `IntEnum` and `IntFlag` now leave `__str__` as the original `int.__str__` so that str() and format() return the same result
- zero-valued flags without a name have a slightly changed repr(), e.g. `repr(Color(0)) == '<Color: 0>'`
- update `dir()` for mixed-in types to return all the methods and attributes of the mixed-in type
- added `_numeric_repr_` to `Flag` to control display of unnamed values
- enums without doc strings have a more comprehensive doc string added
- `ReprEnum` added -- inheriting from this makes it so only `__repr__` is replaced, not `__str__` nor `__format__`; `IntEnum`, `IntFlag`, and `StrEnum` all inherit from `ReprEnum`
2022-01-15 22:41:43 -08:00
6223cbf86a
bpo-45331: [Enum] add rule to docs that mixin type must be subclassable (GH-30521)
2022-01-10 15:42:45 -08:00
b2afdc95cc
bpo-45535: Improve output of Enum ``dir()`` (GH-29316)
...
Modify the ``EnumType.__dir__()`` and ``Enum.__dir__()`` to ensure
that user-defined methods and methods inherited from mixin classes always
show up in the output of `help()`. This change also makes it easier for
IDEs to provide auto-completion.
2021-12-02 08:49:52 -08:00
cb755dba7a
bpo-45740: [Enum] add versionadded markers to docs (GH-29443)
...
[Enum] add versionadded markers to docs
2021-11-06 10:16:43 -07:00
7c4d96103c
bpo-44174: [Enum] add reference to name mangling (GH-29116)
2021-10-20 20:32:11 -07:00
3e5b82ed7e
Small text fixes for enum.rst ( #27322 )
...
Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2021-07-26 17:59:20 +02:00
33d9bf298b
Fix error in Enum documentation example code that was referring to the wrong enum. ( #25837 )
2021-05-04 14:34:14 +02:00
b775106d94
bpo-40066: Enum: modify `repr()` and `str()` (GH-22392)
...
* Enum: streamline repr() and str(); improve docs
- repr() is now ``enum_class.member_name``
- stdlib global enums are ``module_name.member_name``
- str() is now ``member_name``
- add HOW-TO section for ``Enum``
- change main documentation to be an API reference
2021-03-30 21:17:26 -07:00
Alex Waygood
Wei-Hsiang (Matt) Wang
Nice Zombies
Carol Willing
Nikita Sobolev
Ethan Furman
Hugo van Kemenade
Ezio Melotti
Stanley
Bruno Neyra
Julien Palard
Kumar Aditya
Victor Stinner
Elliot Waite
krisaoe