Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Enhance OpenAPI Generator Pydantic Models with typings

オープン
#10 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
openapi, python
領域
api, tooling

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.
主要言語
Python
スター
16
フォーク
3
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

zitadel/client-python のほかの issue

zitadel/client-python の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。