Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Enhance OpenAPI Generator Pydantic Models with typings

Abierto
#10 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
openapi, python
Área
api, tooling

Línea de trabajo

Start by locating the Jinja2 model template that generates the Pydantic classes, then inspect spec/sdk_test.py around the reported constructor usage. Compare explicit init generation with the alternative .pyi approach. Done means regenerated models accept snake_case arguments at runtime and MyPy passes without call-arg ignores.

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

Descripción

Title: Enhance OpenAPI Generator Pydantic Models with Explicit __init__ Signatures for Snake‑case Fields


What

Our generated Pydantic models only declare field aliases, not an explicit constructor signature, so MyPy reports errors when consuming code passes snake_case keyword arguments:

Minimal example

# Generated by OpenAPI Generator (no explicit __init__)
class V2SetHumanProfile(BaseModel):
    given_name: Annotated[str, Field(alias="givenName")]
    family_name: Annotated[str, Field(alias="familyName")]
    # … other fields …
# In test or client code:
profile = V2SetHumanProfile(
    given_name="John",
    family_name="Doe",
)
spec/sdk_test.py:35: error: Unexpected keyword argument "given_name" for "V2SetHumanProfile"; did you mean "givenName"?  [call-arg]

At runtime, Pydantic’s populate_by_name=True accepts given_name/family_name, but MyPy only “sees” the aliased fields and so flags the snake_case kwargs as invalid.


Why

  • Improved DX & autocompletion
    Developers expect Python‑style constructor arguments (given_name, not givenName).
  • Stronger static guarantees
    Eliminates the need for # type: ignore[call-arg] or hand‑written stubs.
  • Consistency
    Keeps runtime behavior and static types in sync.

How

  1. Inject explicit __init__ in the generator template
    Update the Jinja2 model template to emit a constructor exposing snake_case names:

  2. (Alternative) Generate .pyi stubs
    Produce companion stub files with explicit __init__ signatures.

  3. Regenerate the SDK & validate

    • Run the generator with the updated template.
    • Confirm constructors accept snake_case args.
    • Verify MyPy passes without ignores.
Lenguaje dominante
Python
Estrellas
16
Forks
3
Métricas de merge de PR
Sin PR fusionados en 30 d

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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.

Más de zitadel/client-python

Todos los issues de zitadel/client-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.