python / python/mypy

Incorrect stub generation for subclasses of `pydantic.BaseModel`

Aperta
#16,968 5 commenti 5 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

stubgen does not properly generate ellipses for default values set in the scope of the class body of a Pydantic model.

To Reproduce

Running stubgen -m example

# example.py
from pydantic import BaseModel


class Foo(BaseModel):
    abc: int = 1
    xyz: str = "abc"

Should produce

Expected Behavior

# example.pyi
from pydantic import BaseModel

class Foo(BaseModel):
    abc: int = ...
    xyz: str = ...

stubgen should be populating the default annotation with ellipses, instead they are missing.

Actual Behavior

# example.pyi
from pydantic import BaseModel

class Foo(BaseModel):
    abc: int
    xyz: str

Your Environment

  • Mypy version used: mypy 1.8.0 (compiled: yes)
  • Mypy command-line flags: stubgen -m example
  • Mypy configuration options from mypy.ini (and other config files): N/A
  • Python version used: 3.11.8

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 riproducendo il problema con l'example.py mostrato e stubgen -m example, quindi segui il percorso di stubgen che gestisce i valori predefiniti annotati nel corpo della classe per le sottoclassi di pydantic.BaseModel. Il lavoro è completato quando l'example.pyi generato contiene ... per entrambi i valori predefiniti, con una copertura di regressione per questo caso.

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

Valutazione

Stack tecnologico
python
Ambito
tooling
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.