Merge branch 'main' of github.com:openapi-generators/openapi-python-client into issue1123-merge-model

Author: eli-bl

.changeset/fix-model-override.md

@@ -4,6 +4,50 @@ default: patch
 
 # Fix overriding of object property class
 
-Fixed issue #1123, in which a property could end up with the wrong type when combining two object schemas with `allOf`, if the type of the property was itself an object but had a different schema in each. Previously, if the property's type was A in the first schema and B in the second, the resulting schema would use type A for the property.
+Fixed issue #1123, in which a property could end up with the wrong type when combining two object schemas with `allOf`, if the type of the property was itself an object but had a different schema in each. Example:
 
-The new behavior is, that the generator will test whether one of the types A/B is derived from the other. "Derived" here means that the result of `allOf[A, B]` would be exactly identical to B. If so, it will use the class name of B. If not, it will attempt to merge A and B with the usual `allOf` logic to create a new inline schema.
+```yaml
+  ModelA:
+    properties:
+      status:
+        type: string
+      result:
+        - $ref: "#/components/schemas/BaseResult"
+
+  ModelB:
+    allOf:
+      - $ref: "#/components/schemas/ModelA"
+      - properties:
+          result:
+            - $ref: "#/components/schemas/ExtendedResult"
+
+  ModelC:
+    allOf:
+      - $ref: "#/components/schemas/ModelA"
+      - properties:
+          result:
+            - $ref: "#/components/schemas/UnrelatedResult"
+
+  BaseResult:
+    properties:
+      prop1:
+        type: string
+
+  ExtendedResult:
+    allOf:
+      - $ref: "#/components/schemas/BaseResult"
+      - properties:
+          prop2:
+            type: string
+
+  UnrelatedResult:
+    properties:
+      prop3:
+        type: string
+```
+
+Previously, in the generated classes for both `ModelB` and `ModelC`, the type of `result` was being incorrectly set to `BaseResult`.
+
+The new behavior is, when computing `allOf: [A, B]` where `A` and `B` are both objects, any property `P` whose name exists in both schemas will have a schema equivalent to `allOf: [A.P, B.P]`. This is consistent with the basic definition of `allOf`.
+
+When translating this into Python code, the generator will use a type that correctly describes the combined schema for the property. If the combined schema is exactly equal in shape to either `A.P` or `B.P` (implying that one was already derived from the other using `allOf`) then it will reuse the corresponding Python class. Otherwise it will create a new class, just as it would for an inline schema that used `allOf`. Therefore in the example above, the type of `ModelB.result` is `ExtendedResult`, but the type of `ModelC.result` is a new class called `ModelCResult` that includes all the properties from `BaseResult` and `UnrelatedResult`.

.github/workflows/checks.yml

@@ -11,13 +11,13 @@ jobs:
   test:
     strategy:
       matrix:
-        python: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
+        python: [ "3.8", "3.9", "3.10", "3.11", "3.12", "3.13" ]
         os: [ ubuntu-latest, macos-latest, windows-latest ]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4.2.2
       - name: Set up Python
-        uses: actions/setup-python@v5.2.0
+        uses: actions/setup-python@v5.3.0
         with:
           python-version: ${{ matrix.python }}
 
@@ -64,7 +64,7 @@ jobs:
         if: matrix.os == 'ubuntu-latest'
 
       - name: Store coverage report
-        uses: actions/[email protected].0
+        uses: actions/[email protected].3
         if: matrix.os == 'ubuntu-latest'
         with:
           name: coverage-${{ matrix.python }}
@@ -77,7 +77,7 @@ jobs:
     needs: test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4.2.2
       - uses: actions/setup-python@v5
         with:
           python-version: "3.12"
@@ -107,7 +107,7 @@ jobs:
           .venv/bin/python -m coverage report --fail-under=100          
 
       - name: Upload HTML report if check failed.
-        uses: actions/[email protected].0
+        uses: actions/[email protected].3
         with:
           name: html-report
           path: htmlcov
@@ -127,9 +127,9 @@ jobs:
         ports:
           - "3000:3000"
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4.2.2
       - name: Set up Python
-        uses: actions/setup-python@v5.2.0
+        uses: actions/setup-python@v5.3.0
         with:
           python-version: "3.8"
       - name: Get Python Version

.github/workflows/release.yml

@@ -12,12 +12,12 @@ jobs:
     permissions:
       id-token: write
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4.2.2
       - name: Install Hatchling
         run: pip install --upgrade hatchling
       - name: Build
         run: hatchling build
       - name: Push to PyPI
-        uses: pypa/[email protected].1
+        uses: pypa/[email protected].3
         with:
             attestations: true

CHANGELOG.md

@@ -13,6 +13,39 @@ Programmatic usage of this project (e.g., importing it as a Python module) and t
 
 The 0.x prefix used in versions for this project is to indicate that breaking changes are expected frequently (several times a year). Breaking changes will increment the minor number, all other changes will increment the patch number. You can track the progress toward 1.0 [here](https://github.com/openapi-generators/openapi-python-client/projects/2).
 
+## 0.21.6 (2024-10-20)
+
+### Features
+
+- update Ruff to >=0.2,<0.8 (#1137)
+- Add UUID string format. Thanks @estyrke! (#1140)
+- Support OpenAPI 3.1 prefixItems property for arrays. Thanks @estyrke! (#1141)
+
+#### Add `literal_enums` config setting
+
+Instead of the default `Enum` classes for enums, you can now generate `Literal` sets wherever `enum` appears in the OpenAPI spec by setting `literal_enums: true` in your config file.
+
+```yaml
+literal_enums: true
+```
+
+Thanks to @emosenkis for PR #1114 closes #587, #725, #1076, and probably many more. 
+Thanks also to @eli-bl, @expobrain, @theorm, @chrisguillory, and anyone else who helped getting to this design!
+
+### Fixes
+
+- Typo in docstring (#1128)
+
+#### Use literal value instead of `HTTPStatus` enum when checking response statuses
+
+Python 3.13 renamed some of the `HTTPStatus` enum members, which means clients generated with Python 3.13 may not work 
+with older versions of Python. This change stops using the `HTTPStatus` enum directly when checking response statuses.
+
+Statuses will still be checked for validity at generation time, and transformed into `HTTPStatus` _after_ being checked 
+at runtime.
+
+This may cause some linters to complain.
+
 ## 0.21.5 (2024-09-07)
 
 ### Features

README.md

@@ -97,6 +97,17 @@ class_overrides:
 
 The easiest way to find what needs to be overridden is probably to generate your client and go look at everything in the `models` folder.
 
+### literal_enums
+
+By default, `openapi-python-client` generates classes inheriting for `Enum` for enums. It can instead use `Literal` 
+values for enums by setting this to `true`:
+
+```yaml
+literal_enums: true
+```
+
+This is especially useful if enum values, when transformed to their Python names, end up conflicting due to case sensitivity or special symbols.
+
 ### project_name_override and package_name_override
 
 Used to change the name of generated client library project/package. If the project name is changed but an override for the package name

end_to_end_tests/3.1_specific.openapi.yaml

@@ -47,3 +47,34 @@ paths:
             "application/json":
               schema:
                 const: "Why have a fixed response? I dunno"
+  "/prefixItems":
+    post:
+      tags: [ "prefixItems" ]
+      requestBody:
+        required: true
+        content:
+          "application/json":
+            schema:
+              type: object
+              properties:
+                prefixItemsAndItems:
+                  type: array
+                  prefixItems:
+                    - type: string
+                      const: "prefix"
+                    - type: string
+                  items:
+                    type: number
+                prefixItemsOnly:
+                  type: array
+                  prefixItems:
+                    - type: string
+                    - type: number
+                  maxItems: 2
+      responses:
+        "200":
+          description: "Successful Response"
+          content:
+            "application/json":
+              schema:
+                type: string

end_to_end_tests/__snapshots__/test_end_to_end.ambr

@@ -9,6 +9,25 @@
   Circular $ref in request body
 
 
+  If you believe this was a mistake or this tool is missing a feature you need, please open an issue at https://github.com/openapi-generators/openapi-python-client/issues/new/choose
+  
+  '''
+# ---
+# name: test_documents_with_errors[invalid-uuid-defaults]
+  '''
+  Generating /test-documents-with-errors
+  Warning(s) encountered while generating. Client was generated, but some pieces may be missing
+  
+  WARNING parsing PUT / within default. Endpoint will not be generated.
+  
+  cannot parse parameter of endpoint put_: Invalid UUID value: 3
+  
+  
+  WARNING parsing POST / within default. Endpoint will not be generated.
+  
+  cannot parse parameter of endpoint post_: Invalid UUID value: notauuid
+  
+  
   If you believe this was a mistake or this tool is missing a feature you need, please open an issue at https://github.com/openapi-generators/openapi-python-client/issues/new/choose
 
   '''
@@ -36,7 +55,7 @@
 
   Path parameter must be required
 
-  Parameter(name='optional', param_in=<ParameterLocation.PATH: 'path'>, description=None, required=False, deprecated=False, allowEmptyValue=False, style=None, explode=False, allowReserved=False, param_schema=Schema(title=None, multipleOf=None, maximum=None, exclusiveMaximum=None, minimum=None, exclusiveMinimum=None, maxLength=None, minLength=None, pattern=None, maxItems=None, minItems=None, uniqueItems=None, maxProperties=None, minProperties=None, required=None, enum=None, const=None, type=<DataType.STRING: 'string'>, allOf=[], oneOf=[], anyOf=[], schema_not=None, items=None, properties=None, additionalProperties=None, description=None, schema_format=None, default=None, nullable=False, discriminator=None, readOnly=None, writeOnly=None, xml=None, externalDocs=None, example=None, deprecated=None), example=None, examples=None, content=None)
+  Parameter(name='optional', param_in=<ParameterLocation.PATH: 'path'>, description=None, required=False, deprecated=False, allowEmptyValue=False, style=None, explode=False, allowReserved=False, param_schema=Schema(title=None, multipleOf=None, maximum=None, exclusiveMaximum=None, minimum=None, exclusiveMinimum=None, maxLength=None, minLength=None, pattern=None, maxItems=None, minItems=None, uniqueItems=None, maxProperties=None, minProperties=None, required=None, enum=None, const=None, type=<DataType.STRING: 'string'>, allOf=[], oneOf=[], anyOf=[], schema_not=None, items=None, prefixItems=[], properties=None, additionalProperties=None, description=None, schema_format=None, default=None, nullable=False, discriminator=None, readOnly=None, writeOnly=None, xml=None, externalDocs=None, example=None, deprecated=None), example=None, examples=None, content=None)
 
   If you believe this was a mistake or this tool is missing a feature you need, please open an issue at https://github.com/openapi-generators/openapi-python-client/issues/new/choose
 

end_to_end_tests/baseline_openapi_3.0.json

@@ -1666,6 +1666,47 @@
           }
         }
       }
+    },
+    "/models/oneof-with-required-const": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "oneOf": [
+                    {
+                      "type": "object",
+                      "properties": {
+                        "type": {
+                          "const": "alpha"
+                        },
+                        "color": {
+                          "type": "string"
+                        }
+                      },
+                      "required": ["type"]
+                    },
+                    {
+                      "type": "object",
+                      "properties": {
+                        "type": {
+                          "const": "beta"
+                        },
+                        "texture": {
+                          "type": "string"
+                        }
+                      },
+                      "required": ["type"]
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {
@@ -1714,6 +1755,8 @@
           "aCamelDateTime",
           "a_date",
           "a_nullable_date",
+          "a_uuid",
+          "a_nullable_uuid",
           "required_nullable",
           "required_not_nullable",
           "model",
@@ -1784,6 +1827,23 @@
             "type": "string",
             "format": "date"
           },
+          "a_uuid": {
+            "title": "A Uuid",
+            "type": "string",
+            "format": "uuid"
+          },
+          "a_nullable_uuid": {
+            "title": "A Nullable Uuid",
+            "type": "string",
+            "format": "uuid",
+            "nullable": true,
+            "default": "07EF8B4D-AA09-4FFA-898D-C710796AFF41"
+          },
+          "a_not_required_uuid": {
+            "title": "A Not Required Uuid",
+            "type": "string",
+            "format": "uuid"
+          },
           "1_leading_digit": {
             "title": "Leading Digit",
             "type": "string"