python / python/cpython

EnumType __call__ method description does not match the implementation

Open
#119,110 1 comment 0 reactions 1 assignee View on GitHub

@ethanfurman is already working on this.

Since May 17, 2024.

docs stdlib
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

Documentation

See EnumType.call documentation, where the prototype is:

__call__(cls, value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

While in the enum.py source code there is:

def __call__(cls, value, names=_not_given, *values, module=None, qualname=None, type=None, start=1, boundary=None):
  1. The _not_given helper behaves differently than None, which even breaks compatibility with previous versions (this change was introduced in 3.12.3), when one needs to do some customization of enum metaclass.

    • e.g. as propsed on the stack overflow to implement enum item deprecation warning - note that this implementation stops working in 3.12.3 since the call of the parent EnumType.__call__ passes None instead of _not_given and it causes different behavior.
  2. Note * vs. *values, which I believe even behaves differently.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.