python / python/mypy

Unable to stubify Enum so it can be used with Literals, without using type ignore

Open
#16,007 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug topic-enum
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

Bug Report

Extending the example for #3434 I want to define an enum Flag, combine some of the members, and then also reference those members as a TypeAlias in a stub file.

class Color1(Flag):
    RED = auto()
    BLUE = auto()
    GREEN = auto()
    WHITE = RED | BLUE | GREEN  # <-- This line works at runtime but not in a stub (see the gist)
# Invalid type: try using Literal[Color1.RED] instead
Favorites: TypeAlias = Literal[Color3.RED | Color3.BLUE]

(A clear and concise description of what the bug is.)

To Reproduce

https://mypy-play.net/?mypy=latest&python=3.11&gist=d270d7541c61b2aea87e99c9afc77534

Expected Behavior

I expect mypy to suggest working code, or to accept the | operator for Flag members.

Actual Behavior

See the gist, but depending on how I write the stub I get these errors for the member definition

# foo.pyi:9: error: Invalid type: try using Literal[Color1.RED] instead?  [valid-type]
# foo.pyi:9: error: Invalid type: try using Literal[Color1.BLUE] instead?  [valid-type]
# foo.pyi:9: error: Invalid type: try using Literal[Color1.GREEN] instead?  [valid-type]

or these for the TypeAlias

# foo.pyi:12: error: Parameter 1 of Literal[...] cannot be of type "Any"  [valid-type]

Your Environment

  • Mypy version used: 1.5.1
  • Mypy command-line flags: --strict
  • Mypy configuration options from mypy.ini (and other config files): N/A
  • Python version used: 3.10.13

I was curious what stubgen came up with:

from _typeshed import Incomplete
from enum import Flag
from typing import TypeAlias

class Color(Flag):
    RED: Incomplete
    BLUE: Incomplete
    GREEN: Incomplete
    WHITE: Incomplete

Favorites: TypeAlias

but that loses information about the Literal Favorite Colors.

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 with the mypy-play reproduction and the foo.pyi examples in the report, focusing on Flag member definitions and the Literal TypeAlias. Compare the reported valid-type and Any errors with the expected handling of combined Flag members; done means the intended stub preserves the literal color information without requiring type ignores.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
compilers
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.