python / python/mypy

Allow enum with zero members (rational provided)

Open
#21,730 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

Feature

Just an option to bypass an error message and allow this:

class E(enum.IntEnum):
    pass

E1: E
E2: E
E3: E

Pitch

Compared to this, it has the advantage below:

class E(enum.IntEnum):
    E1 = ...
    E2 = ...
    E3 = ...

E1 = E.E1
E2 = E.E2
E3 = E.E3

When a Python API maps a C/C++ API, enum members are typically declared as int. But this is a pity, because it does not catch mixing of enum types. Also, when an enum match a C enum in an API, it is better if the class representing the type, does not have any member, because the members are aliased outside. Yes, one can write all enums instances are all of the same int type, but this is braking typing.

Also, there is an inconsistency, because in a loadable module, MyPy does not complain if an enum has no member. So why not allow it in stubs?

A practical case where the idea came to me, but I was sad to discover it does not work in stubs, while MyPy did not complain when I tried an enum with no members in a loadable module: https://github.com/AlexionSoftware/types-wxpython/issues/42#issuecomment-4962290300 . I prefer to wait for comments on this proposal, before editing the message linked, to say unfortunately it does not work, would prefer saying it just requires an option to be set.

Instead of a working clean idiom, I get this kind of error for each enum class declaration:

error: Detected enum "wx.StandardPaths.ResourceCat" in a type stub with zero members. There is a chance this is due to a recent change in the semantics of enum membership. If so, use member = value to mark an enum member, instead of member: type [misc]

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.

Research direction

Start by reproducing the reported diagnostic for the zero-member enum in a type stub, then compare it with the loadable-module case described in the issue. Read the enum-membership checking path and the existing error message; done means a deliberate option can allow the stub form without weakening ordinary enum checks, with coverage for both cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.