Skip to content

[Enum] __text_signature__ of EnumType.__call__ and derivatives #100039

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom
Closed
ethanfurman opened this issue Dec 5, 2022 · 1 comment
Closed

[Enum] __text_signature__ of EnumType.__call__ and derivatives #100039

ethanfurman opened this issue Dec 5, 2022 · 1 comment
Assignees
@ethanfurman
Labels
3.12 only security fixes stdlib Python modules in the Lib dir type-feature A feature request or enhancement

Comments

@ethanfurman
Copy link
Member

ethanfurman commented Dec 5, 2022 •
edited by bedevere-bot
Loading

EnumType.__call__ is a dual-purpose method:

  • create a new enum class (functional API, and only valid if the parent enum has no members)
  • look up an existing member (only valid if enum has members)

Enhancement: Have the appropriate __text_signature__ set for each enum/flag.

Linked PRs
@ethanfurman ethanfurman added type-feature A feature request or enhancement stdlib Python modules in the Lib dir 3.12 only security fixes labels Dec 5, 2022
@ethanfurman ethanfurman self-assigned this Dec 5, 2022
@ethanfurman ethanfurman mentioned this issue Dec 5, 2022
Closed
@ethanfurman
Copy link
Member Author

Okay, __text_signature__ is not settable on a class (so, for example, not on enum.Enum). It would take some changes in the C code and possibly to internal data structures to make that work.

So instead I have a patch that augments inspect to be able to properly interpret __signature__ when it is a classmethod that returns a string.

@bedevere-bot bedevere-bot mentioned this issue Dec 11, 2022
Merged
ethanfurman added a commit that referenced this issue Dec 16, 2022
@ethanfurman
gh-100039: enhance __signature__ to work with str and callables (GH-1…
a5a7cea 
…00168)

Callables should be either class- or static-methods.
Enum now uses the classmethod version to greatly improve the help
given for enums and flags.
carljm added a commit to carljm/cpython that referenced this issue Dec 16, 2022
@carljm
Merge branch 'main' into fastmock
1b6241a 
* main:
  pythongh-99540: Constant hash for _PyNone_Type to aid reproducibility (pythonGH-99541)
  pythongh-100039: enhance __signature__ to work with str and callables (pythonGH-100168)
  pythongh-99830: asyncio: Document returns of remove_{reader,writer} (python#100302)
  "Compound statement" docs: Fix with-statement step indexing (python#100286)
  pythonGH-90043: Handle NaNs in COMPARE_OP_FLOAT_JUMP (pythonGH-100278)
shihai1991 added a commit to shihai1991/cpython that referenced this issue Dec 18, 2022
@shihai1991
Merge remote-tracking branch 'origin/main' into bpo_34697
2878571 
* origin/main: (1306 commits)
  Correct CVE-2020-10735 documentation (python#100306)
  pythongh-100272: Fix JSON serialization of OrderedDict (pythonGH-100273)
  pythongh-93649: Split tracemalloc tests from _testcapimodule.c (python#99551)
  Docs: Use `PY_VERSION_HEX` for version comparison (python#100179)
  pythongh-97909: Fix markup for `PyMethodDef` members (python#100089)
  pythongh-99240: Reset pointer to NULL when the pointed memory is freed in argument parsing (python#99890)
  pythongh-99240: Reset pointer to NULL when the pointed memory is freed in argument parsing (python#99890)
  pythonGH-98831: Add DECREF_INPUTS(), expanding to DECREF() each stack input (python#100205)
  pythongh-78707: deprecate passing >1 argument to `PurePath.[is_]relative_to()` (pythonGH-94469)
  pythongh-99540: Constant hash for _PyNone_Type to aid reproducibility (pythonGH-99541)
  pythongh-100039: enhance __signature__ to work with str and callables (pythonGH-100168)
  pythongh-99830: asyncio: Document returns of remove_{reader,writer} (python#100302)
  "Compound statement" docs: Fix with-statement step indexing (python#100286)
  pythonGH-90043: Handle NaNs in COMPARE_OP_FLOAT_JUMP (pythonGH-100278)
  Improve stats presentation for calls. (pythonGH-100274)
  Better stats for `LOAD_ATTR` and `STORE_ATTR` (pythonGH-100295)
  pythongh-81057: Move the Cached Parser Dummy Name to _PyRuntimeState (python#100277)
  Document that zipfile's pwd parameter is a `bytes` object (python#100209)
  pythongh-99767: mark `PyTypeObject.tp_watched` as internal use only in table (python#100271)
  Fix typo in introduction.rst (python#100266)
  ...
@skirpichev skirpichev mentioned this issue Feb 27, 2024
Closed
This was referenced Feb 29, 2024
Merged
Closed
Closed
@serhiy-storchaka serhiy-storchaka mentioned this issue Apr 30, 2024
Open
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees

@ethanfurman ethanfurman

Labels
3.12 only security fixes stdlib Python modules in the Lib dir type-feature A feature request or enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ethanfurman