Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Enhance OpenAPI Generator Pydantic Models with typings

Đang mở
#10 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
openapi, python
Lĩnh vực
api, tooling

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
Python
Star
16
Fork
3
Không có pull request nào được merge trong 30 ngày

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của zitadel/client-python

Tất cả issue của zitadel/client-python

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.