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

Model named `Client` causes errors

Offen
#1,045 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Python
Sterne
2k
Forks
293
Ø Merge
34 Min.
Gemergte PRs (30 T.)
1

Beschreibung

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).

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Reproduziere das Problem mit der bereitgestellten OpenAPI-Spezifikation und überprüfe anschließend die Imports in der generierten Datei fast_api_client/api/default/client_client_get.py. Die Korrektur ist abgeschlossen, wenn die generierten Modell- und Client-Typen nicht mehr kollidieren und ruff ohne den Fehler F811 durchläuft.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
api, tooling
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
42/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.