python / python/mypy

Allow defining type for dynamically generated types.

Abierto
#19,360 4 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

feature topic-plugins
Lenguaje dominante
Python
Estrellas
20.6k
Forks
3.3k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

Feature
Add a way to allow defining or overriding types for dynamically generated types, such as pydantic's create_model.

Pitch
Pydantic provides a way to create models dynamically (create_model).
The problem is that mypy always complain about these models:

sample code (a.py)

from pydantic import create_model, BaseModel
from pydantic.fields import Field

GeneratedModel = create_model(
    "MyModel",
    some_field=(int, Field(default=0))
)


class MyModel(BaseModel):
    a: int
    model: GeneratedModel

mypy a.py

a.py:12: error: Variable "a.GeneratedModel" is not valid as a type  [valid-type]
a.py:12: note: See https://mypy.readthedocs.io/en/stable/common_issues.html#variables-vs-type-aliases
Found 1 error in 1 file (checked 1 source file)

Currently, you are forced to add # type: ignore[valid-type] on each line where this model is used, which is a problem because it adds a lot of noise but also disables the check for all variables in the same line as this type: ignore.

I've tried things like these, with no luck:

# attempt 1
GeneratedModel: type[Any] = create_model(...)

# attempt 2
GeneratedModel = create_model(
    "MyModel",
    some_field=(int, Field(default=0))
)

GeneratedModel = cast(type[Any], GeneratedModel)

# attempt 3
def is_pydantic_model(model: Any) -> TypeGuard[BaseModel]:
    return isinstance(model, BaseModel)

GeneratedModel = create_model(
    "MyModel",
    some_field=(int, Field(default=0))
)
is_pydantic_model(GeneratedModel)

But I always get the same [valid-type] warning everywhere where this type is used.

The actual real workaround today is to define the type in a different file and import from somewhere else, but that is already marked as bug .

edit: Fixed FieldInfo->Field

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Empieza reproduciendo el ejemplo de a.py con mypy y revisando el diagnóstico actual de valid-type. El cambio estará terminado cuando un tipo producido por pydantic's create_model pueda usarse en anotaciones sin repetir valid-type ignores, mientras las comprobaciones no relacionadas de la misma línea sigan activas.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
compilers
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
30/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.