python / python/mypy

mutable-override does not understand unions

Open
#20,028 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Bug Report
If I enable mutable-override it fails as it does not understand simple unions.

To Reproduce
Turn on mutable-override

class Base:
    val: bool|None = True
    
class Derived(Base):
    val = False

Gist: https://gist.github.com/mypy-play/aeec67e97957ea9e60431ce8466d8af3
Playground: https://mypy-play.net/?mypy=latest&python=3.12&enable-error-code=mutable-override&gist=aeec67e97957ea9e60431ce8466d8af3

Expected Behavior
no error

Actual Behavior

main.py:5: error: Covariant override of a mutable attribute (base class "Base" defined the type as "bool | None", expression has type "bool")  [mutable-override]
Found 1 error in 1 file (checked 1 source file)

Your Environment

  • Mypy version used: 1.18.2
  • Mypy command-line flags: enable-error-code="mutable-override"
  • Python version used: 3.12

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

Reproduce the report with the provided Base/Derived example on mypy 1.18.2 with mutable-override enabled, then trace the mutable-override type-checking entry point for union annotations. Done means the example produces no error while the existing mutable-attribute override checks continue to work.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
compilers, devtools
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.