openapi-generators / openapi-generators/openapi-python-client

Model named `Client` causes errors

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

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

主要言語
Python
スター
2k
フォーク
293
平均マージ
34分
マージ済み PR(30日)
1

説明

Describe the bug
If a model of the Openapi App is called Client this name collides with the client.Client object in imports.

OpenAPI Spec File

{
  "openapi": "3.1.0",
  "info": {
    "title": "FastAPI",
    "version": "0.1.0"
  },
  "paths": {
    "/client": {
      "get": {
        "summary": "Client",
        "operationId": "client_client_get",
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Client"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Client": {
        "properties": {
          "foo": {
            "type": "string",
            "title": "Foo"
          },
          "bar": {
            "type": "integer",
            "title": "Bar"
          }
        },
        "type": "object",
        "required": [
          "foo",
          "bar"
        ],
        "title": "Client"
      }
    }
  }
}

Desktop (please complete the following information):

  • OS: [e.g. Ubuntu 22.04]
  • Python Version: [e.g. 3.10.12]
  • openapi-python-client version [e.g. 0.19.1]

Additional context
The generator outputs:

Generating fast-api-client
Error(s) encountered while generating, client was not created

ruff failed

fast_api_client/api/default/client_client_get.py:8:30: F811 Redefinition of unused `Client` from line 7
Found 16 errors (15 fixed, 1 remaining).

In the relevant code there are two imports:

from ...client import AuthenticatedClient, Client
from ...models.client import Client

As hinted by ruff' error message there are two imports that load a Client object but they are loading different objects.
If you ty to use the generated code:

from fast_api_client import Client
from fast_api_client.api.default import client_client_get

with Client(base_url="http://localhost:8000") as client:
    data = client_client_get.sync(client=client)

print(data)

It will still work properly as the only Client type that is actually used at runtime is the one from models which is imported last (the Client from client is only used for type-hinting).

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

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

はじめの一歩

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

調査の方向性

提供された OpenAPI 仕様で問題を再現し、その後、生成された fast_api_client/api/default/client_client_get.py の import を調査します。生成されたモデル型とクライアント型が衝突しなくなり、ruff が F811 エラーなしで通過すれば修正は完了です。

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

評価

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

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

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