python / python/mypy

overloaded __new__ ignored when introducing __init__

Aperta
#17,251 2 commenti 3 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

bug
Lingua principale
Python
Stelle
20.6k
Fork
3.3k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

Bug Report
I'm hitting a problem where the return type of an overloaded __new__ is ignored once an __init__ is added. I've searched the issue tracker thoroughly and while I've found a ton of issues related to __new__ return types I haven't found one that seems to be the same thing.

To Reproduce

from __future__ import annotations

from typing import (
    Any,
    Generic,
    TypeVar,
    overload,
)

BE = TypeVar("BE", bound=BaseException)
E = TypeVar("E", bound=Exception)


class MyBaseClass(Generic[BE]):
    @overload
    def __new__(cls, arg: type[E]) -> MyClass[E]:
        ...
    @overload
    def __new__(cls, arg: type[BE]) -> MyBaseClass[BE]:
        ...

    def __new__(cls, arg: Any) -> Any:
        if issubclass(arg, Exception):
            return MyClass(arg)
        return MyBaseClass(arg)

    def __init__(self, arg: type[BE]):  # pyright: ignore[reportInconsistentConstructor]
        self.arg = arg

class MyClass(MyBaseClass[E]):
    def __init__(self, arg: type[E]):  # pyright: ignore[reportInconsistentConstructor]
        self.arg = arg


reveal_type(MyBaseClass(ValueError))
reveal_type(MyBaseClass(KeyboardInterrupt))

I've also found it ~impossible to type the signatures for the __new__ and __init__ implementation, but that's a separate issue.

Actual Behavior

$  mypy foo.py                                             
foo.py:36: note: Revealed type is "foo.MyBaseClass[builtins.ValueError]"
foo.py:37: note: Revealed type is "foo.MyBaseClass[builtins.KeyboardInterrupt]"

pyright handles it without issue.

$ pyright foo.py
  ./foo.py:36:13 - information: Type of "MyBaseClass(ValueError)" is "MyClass[ValueError]"
  ./foo.py:37:13 - information: Type of "MyBaseClass(KeyboardInterrupt)" is "MyBaseClass[KeyboardInterrupt]" 

and if I remove the __init__ from MyBaseClass then mypy handles the overloads correctly:

$  mypy foo.py
foo.py:36: note: Revealed type is "foo.MyClass[builtins.ValueError]"
foo.py:37: note: Revealed type is "foo.MyBaseClass[builtins.KeyboardInterrupt]"
Success: no issues found in 1 source file

Your Environment

  • Mypy version used: 1.10.0
  • Mypy command-line flags: none
  • Mypy configuration options from mypy.ini (and other config files): none
  • Python version used: 3.11.8

The source of the problem is trying to improve the typing of trio.testing.RaisesGroup: https://github.com/python-trio/trio/pull/2989

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia eseguendo la riproduzione in foo.py con mypy 1.10.0 e confronta i tipi rivelati con l'output previsto e i risultati di pyright. Traccia il modo in cui mypy gestisce un new sovraccarico quando è presente init; il lavoro è completato quando i due risultati di reveal_type corrispondono ai tipi previsti MyClass[ValueError] e MyBaseClass[KeyboardInterrupt], senza introdurre una regressione nel caso in cui init sia assente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
devtools
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.