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

union types and nullables can create unnecessary class suffixes (and related problems)

未關閉
#1,120 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

主要語言
Python
星號
2k
分支
293
平均合併
34 分鐘
30 天內合併 PR
1

描述

Describe the bug
In some valid specs, the use of anyOf, oneOf, nullable, and/or type as a list, can cause generated class names to have unnecessary suffixes (and, sometimes, for spurious extra copies of classes to appear). These problems seem to all ultimately come from the behavior of UnionProperty.

The problem cases are all included in the attached specs files. Looking at the code generated from these specs—

in both 3.0 & 3.1:

  • ExampleModel.nullableObjectWithOneOf correctly has the type Union[MyObject, None, Unset].
  • ExampleModel.inlineNullableObject generates a model class called ExampleModelInlineNullableObjectType0. It should be just ExampleModelInlineNullableObject, since there are no other named types for this property.
  • Similarly, the MyEnum schema, which is a nullable enum, generates the class MyEnumType1 even though there is no Type0.
  • The MyEnumWithExplicitType schema is the same as MyEnum except it specifically indicates type, and the result is a bit wilder: it generates enum classes MyEnumWithExplicitTypeType1, MyEnumWithExplicitType2Type1, and MyEnumWithExplicitType3Type1, all of which are exactly the same.

only applicable to 3.1:

  • ExampleModel.nullableObjectWithExplicitTypes, which is the same as nullable_object_with_one_of except that it also (unnecessarily, but validly) specifies type: ["object", "null"], also works correctly.
  • ExampleModel.one_of_enums_with_explicit_types, which combines a string enum with an int enum and specifies `type: ["string", "integer"], has the problem where three classes are created for each enum.

OpenAPI Spec Files
3.0: https://gist.github.com/eli-bl/7bea406525fb3b1452a71781ada5c1c0
3.1: https://gist.github.com/eli-bl/c03c88eb69312053e0122d1d8a06c2a0

Desktop (please complete the following information):

  • OS: macOS 14.5
  • Python Version: 3.8.15
  • openapi-python-client version 0.21.5

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

從 UnionProperty 的行為開始,並根據連結的 OpenAPI 3.0 和 3.1 規格檔案產生用戶端。將產生的類別名稱和重複模型與 issue 中描述的範例進行比較。當 nullable 和聯集 schema 不再接收不必要的後綴,也不再建立相同的額外類別時,即表示完成。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
openapi, python
領域
devtools
Issue 類型
缺陷
難度
4/5
預估耗時
3-5 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。