datamodel-code-generator 0.31.2__tar.gz → 0.32.0__tar.gz

{datamodel_code_generator-0.31.2 → datamodel_code_generator-0.32.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datamodel-code-generator
-Version: 0.31.2
+Version: 0.32.0
 Summary: Datamodel Code Generator
 Project-URL: Homepage, https://github.com/koxudaxi/datamodel-code-generator
 Project-URL: Source, https://github.com/koxudaxi/datamodel-code-generator
@@ -552,6 +552,9 @@ Template customization:
                         option (require black 20.8b0 or later)
 
 OpenAPI-only options:
+  --include-path-parameters
+                        Include path parameters in generated parameter models in addition to
+                        query parameters (Only OpenAPI)
   --openapi-scopes {schemas,paths,tags,parameters} [{schemas,paths,tags,parameters} ...]
                         Scopes of OpenAPI model generation (default: schemas)
   --strict-nullable     Treat default field as a non-nullable field (Only OpenAPI)

{datamodel_code_generator-0.31.2 → datamodel_code_generator-0.32.0}/README.md

@@ -502,6 +502,9 @@ Template customization:
                         option (require black 20.8b0 or later)
 
 OpenAPI-only options:
+  --include-path-parameters
+                        Include path parameters in generated parameter models in addition to
+                        query parameters (Only OpenAPI)
   --openapi-scopes {schemas,paths,tags,parameters} [{schemas,paths,tags,parameters} ...]
                         Scopes of OpenAPI model generation (default: schemas)
   --strict-nullable     Treat default field as a non-nullable field (Only OpenAPI)

{datamodel_code_generator-0.31.2 → datamodel_code_generator-0.32.0}/src/datamodel_code_generator/__init__.py

@@ -258,6 +258,7 @@ def generate(  # noqa: PLR0912, PLR0913, PLR0914, PLR0915
     field_include_all_keys: bool = False,
     field_extra_keys_without_x_prefix: set[str] | None = None,
     openapi_scopes: list[OpenAPIScope] | None = None,
+    include_path_parameters: bool = False,
     graphql_scopes: list[GraphQLScope] | None = None,  # noqa: ARG001
     wrap_string_literal: bool | None = None,
     use_title_as_name: bool = False,
@@ -327,6 +328,7 @@ def generate(  # noqa: PLR0912, PLR0913, PLR0914, PLR0915
 
         parser_class: type[Parser] = OpenAPIParser
         kwargs["openapi_scopes"] = openapi_scopes
+        kwargs["include_path_parameters"] = include_path_parameters
     elif input_file_type == InputFileType.GraphQL:
         from datamodel_code_generator.parser.graphql import GraphQLParser  # noqa: PLC0415
 

{datamodel_code_generator-0.31.2 → datamodel_code_generator-0.32.0}/src/datamodel_code_generator/__main__.py

@@ -287,6 +287,7 @@ class Config(BaseModel):
     field_include_all_keys: bool = False
     field_extra_keys_without_x_prefix: Optional[set[str]] = None  # noqa: UP045
     openapi_scopes: Optional[list[OpenAPIScope]] = [OpenAPIScope.Schemas]  # noqa: UP045
+    include_path_parameters: bool = False
     wrap_string_literal: Optional[bool] = None  # noqa: UP045
     use_title_as_name: bool = False
     use_operation_id_as_name: bool = False
@@ -500,6 +501,7 @@ def main(args: Sequence[str] | None = None) -> Exit:  # noqa: PLR0911, PLR0912,
             field_include_all_keys=config.field_include_all_keys,
             field_extra_keys_without_x_prefix=config.field_extra_keys_without_x_prefix,
             openapi_scopes=config.openapi_scopes,
+            include_path_parameters=config.include_path_parameters,
             wrap_string_literal=config.wrap_string_literal,
             use_title_as_name=config.use_title_as_name,
             use_operation_id_as_name=config.use_operation_id_as_name,

{datamodel_code_generator-0.31.2 → datamodel_code_generator-0.32.0}/src/datamodel_code_generator/arguments.py

@@ -500,6 +500,12 @@ openapi_options.add_argument(
     action="store_true",
     default=None,
 )
+openapi_options.add_argument(
+    "--include-path-parameters",
+    help="Include path parameters in generated parameter models in addition to query parameters (Only OpenAPI)",
+    action="store_true",
+    default=None,
+)
 openapi_options.add_argument(
     "--validation",
     help="Deprecated: Enable validation (Only OpenAPI). this option is deprecated. it will be removed in future "

{datamodel_code_generator-0.31.2 → datamodel_code_generator-0.32.0}/src/datamodel_code_generator/model/pydantic/types.py

@@ -141,7 +141,7 @@ number_kwargs: set[str] = {
 
 string_kwargs: set[str] = {"minItems", "maxItems", "minLength", "maxLength", "pattern"}
 
-byes_kwargs: set[str] = {"minLength", "maxLength"}
+bytes_kwargs: set[str] = {"minLength", "maxLength"}
 
 escape_characters = str.maketrans({
     "'": r"\'",
@@ -296,7 +296,7 @@ class DataTypeManager(_DataTypeManager):
         return self.type_map[types]
 
     def get_data_bytes_type(self, types: Types, **kwargs: Any) -> DataType:
-        data_type_kwargs: dict[str, Any] = self.transform_kwargs(kwargs, byes_kwargs)
+        data_type_kwargs: dict[str, Any] = self.transform_kwargs(kwargs, bytes_kwargs)
         strict = StrictTypes.bytes in self.strict_types
         if data_type_kwargs and not strict:
             return self.data_type.from_import(IMPORT_CONBYTES, kwargs=data_type_kwargs)

{datamodel_code_generator-0.31.2 → datamodel_code_generator-0.32.0}/src/datamodel_code_generator/model/template/Union.jinja2

@@ -1,5 +1,5 @@
 {%- if description %}
-# {{ description }}
+# {{ description | replace('\n', '\n# ') }}
 {%- endif %}
 {%- if fields|length > 1 %}
 {{ class_name }}: TypeAlias = Union[

{datamodel_code_generator-0.31.2 → datamodel_code_generator-0.32.0}/src/datamodel_code_generator/parser/base.py

@@ -389,6 +389,7 @@ class Parser(ABC):
             python_version=target_python_version,
             use_standard_collections=use_standard_collections,
             use_generic_container_types=use_generic_container_types,
+            use_non_positive_negative_number_constrained_types=use_non_positive_negative_number_constrained_types,
             strict_types=strict_types,
             use_union_operator=use_union_operator,
             use_pendulum=use_pendulum,

{datamodel_code_generator-0.31.2 → datamodel_code_generator-0.32.0}/src/datamodel_code_generator/parser/graphql.py

@@ -308,6 +308,7 @@ class GraphQLParser(Parser):
             required=False,
             alias="__typename",
             use_one_literal_as_default=True,
+            use_default_kwarg=self.use_default_kwarg,
             has_default=True,
         )
 

{datamodel_code_generator-0.31.2 → datamodel_code_generator-0.32.0}/src/datamodel_code_generator/parser/jsonschema.py

@@ -211,6 +211,33 @@ class JsonSchemaObject(BaseModel):
             return value.replace("#", "#/")
         return value
 
+    @field_validator("required", mode="before")
+    def validate_required(cls, value: Any) -> Any:  # noqa: N805
+        if value is None:
+            return []
+        if isinstance(value, list):  # noqa: PLR1702
+            # Filter to only include valid strings, excluding invalid objects
+            required_fields: list[str] = []
+            for item in value:
+                if isinstance(item, str):
+                    required_fields.append(item)
+
+                # In some cases, the required field can include "anyOf", "oneOf", or "allOf" as a dict (#2297)
+                elif isinstance(item, dict):
+                    for key, val in item.items():
+                        if isinstance(val, list):
+                            # If 'anyOf' or "oneOf" is present, we won't include it in required fields
+                            if key in {"anyOf", "oneOf"}:
+                                continue
+
+                            if key == "allOf":
+                                # If 'allOf' is present, we include them as required fields
+                                required_fields.extend(sub_item for sub_item in val if isinstance(sub_item, str))
+
+            value = required_fields
+
+        return value
+
     items: Optional[Union[list[JsonSchemaObject], JsonSchemaObject, bool]] = None  # noqa: UP007, UP045
     uniqueItems: Optional[bool] = None  # noqa: N815, UP045
     type: Optional[Union[str, list[str]]] = None  # noqa: UP007, UP045
@@ -1376,6 +1403,7 @@ class JsonSchemaParser(Parser):
                 custom_template_dir=self.custom_template_dir,
                 type_=_get_type(obj.type, obj.format) if self.use_subclass_enum and isinstance(obj.type, str) else None,
                 default=obj.default if obj.has_default else UNDEFINED,
+                treat_dot_as_module=self.treat_dot_as_module,
             )
             self.results.append(enum)
             return self.data_type(reference=reference_)
@@ -1552,7 +1580,7 @@ class JsonSchemaParser(Parser):
         raw: dict[str, Any],
         path: list[str],
     ) -> None:
-        self.parse_obj(name, self.SCHEMA_OBJECT_TYPE.parse_obj(raw), path)
+        self.parse_obj(name, self.SCHEMA_OBJECT_TYPE.model_validate(raw), path)
 
     def parse_obj(
         self,

{datamodel_code_generator-0.31.2 → datamodel_code_generator-0.32.0}/src/datamodel_code_generator/parser/openapi.py

@@ -189,6 +189,7 @@ class OpenAPIParser(JsonSchemaParser):
         field_include_all_keys: bool = False,
         field_extra_keys_without_x_prefix: set[str] | None = None,
         openapi_scopes: list[OpenAPIScope] | None = None,
+        include_path_parameters: bool = False,
         wrap_string_literal: bool | None = False,
         use_title_as_name: bool = False,
         use_operation_id_as_name: bool = False,
@@ -299,6 +300,7 @@ class OpenAPIParser(JsonSchemaParser):
             parent_scoped_naming=parent_scoped_naming,
         )
         self.open_api_scopes: list[OpenAPIScope] = openapi_scopes or [OpenAPIScope.Schemas]
+        self.include_path_parameters: bool = include_path_parameters
 
     def get_ref_model(self, ref: str) -> dict[str, Any]:
         ref_file, ref_path = self.model_resolver.resolve_ref(ref).split("#", 1)
@@ -351,13 +353,17 @@ class OpenAPIParser(JsonSchemaParser):
         name: str,
         request_body: RequestBodyObject,
         path: list[str],
-    ) -> None:
+    ) -> dict[str, DataType]:
+        data_types: dict[str, DataType] = {}
         for (
             media_type,
             media_obj,
         ) in request_body.content.items():
             if isinstance(media_obj.schema_, JsonSchemaObject):
-                self.parse_schema(name, media_obj.schema_, [*path, media_type])
+                data_types[media_type] = self.parse_schema(name, media_obj.schema_, [*path, media_type])
+            elif media_obj.schema_ is not None:
+                data_types[media_type] = self.get_ref_data_type(media_obj.schema_.ref)
+        return data_types
 
     def parse_responses(
         self,
@@ -414,15 +420,24 @@ class OpenAPIParser(JsonSchemaParser):
         name: str,
         parameters: list[ReferenceObject | ParameterObject],
         path: list[str],
-    ) -> None:
+    ) -> DataType | None:
         fields: list[DataModelFieldBase] = []
         exclude_field_names: set[str] = set()
         reference = self.model_resolver.add(path, name, class_name=True, unique=True)
         for parameter_ in parameters:
             parameter = self.resolve_object(parameter_, ParameterObject)
             parameter_name = parameter.name
-            if not parameter_name or parameter.in_ != ParameterLocation.query:
+            if (
+                not parameter_name
+                or parameter.in_ not in {ParameterLocation.query, ParameterLocation.path}
+                or (parameter.in_ == ParameterLocation.path and not self.include_path_parameters)
+            ):
                 continue
+
+            if any(field.original_name == parameter_name for field in fields):
+                msg = f"Parameter name '{parameter_name}' is used more than once."
+                raise Exception(msg)  # noqa: TRY002
+
             field_name, alias = self.model_resolver.get_valid_field_name_and_alias(
                 field_name=parameter_name, excludes=exclude_field_names
             )
@@ -500,6 +515,9 @@ class OpenAPIParser(JsonSchemaParser):
                     treat_dot_as_module=self.treat_dot_as_module,
                 )
             )
+            return self.data_type(reference=reference)
+
+        return None
 
     def parse_operation(
         self,
@@ -518,7 +536,9 @@ class OpenAPIParser(JsonSchemaParser):
             path_name = operation.operationId
             method = ""
         self.parse_all_parameters(
-            self._get_model_name(path_name, method, suffix="ParametersQuery"),
+            self._get_model_name(
+                path_name, method, suffix="Parameters" if self.include_path_parameters else "ParametersQuery"
+            ),
             operation.parameters,
             [*path, "parameters"],
         )

datamodel_code_generator-0.32.0/tests/data/expected/main/graphql/annotated_use_default_kwarg.py

@@ -0,0 +1,31 @@
+# generated by datamodel-codegen:
+#   filename:  annotated.graphql
+#   timestamp: 2019-07-26T00:00:00+00:00
+
+from __future__ import annotations
+
+from typing import List, Literal, Optional, TypeAlias
+
+from pydantic import BaseModel, Field
+
+Boolean: TypeAlias = bool
+"""
+The `Boolean` scalar type represents `true` or `false`.
+"""
+
+
+String: TypeAlias = str
+"""
+The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
+"""
+
+
+class A(BaseModel):
+    field: String
+    listField: List[String]
+    listListField: List[List[String]]
+    listOptionalField: List[Optional[String]]
+    optionalField: Optional[String] = None
+    optionalListField: Optional[List[String]] = None
+    optionalListOptionalField: Optional[List[Optional[String]]] = None
+    typename__: Optional[Literal['A']] = Field(default='A', alias='__typename')

datamodel_code_generator-0.32.0/tests/data/expected/main/jsonschema/treat_dot_as_module/complex/directory/api/path/basic_enum.py

@@ -0,0 +1,21 @@
+# generated by datamodel-codegen:
+#   filename:  complex.directory/api.path.basic_enum.json
+#   timestamp: 2019-07-26T00:00:00+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class ProcessingStatus(Enum):
+    COMPLETED = 'COMPLETED'
+    PENDING = 'PENDING'
+    FAILED = 'FAILED'
+
+
+class BasicEnum(BaseModel):
+    processing_status: Optional[ProcessingStatus] = 'COMPLETED'
+    name: Optional[str] = None

datamodel_code_generator-0.32.0/tests/data/expected/main/jsonschema/treat_dot_not_as_module/complex.directory/api_path_basic_enum.py

@@ -0,0 +1,21 @@
+# generated by datamodel-codegen:
+#   filename:  complex.directory/api.path.basic_enum.json
+#   timestamp: 2019-07-26T00:00:00+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class ProcessingStatus(Enum):
+    COMPLETED = 'COMPLETED'
+    PENDING = 'PENDING'
+    FAILED = 'FAILED'
+
+
+class BasicEnum(BaseModel):
+    processing_status: Optional[ProcessingStatus] = 'COMPLETED'
+    name: Optional[str] = None

datamodel_code_generator-0.32.0/tests/data/expected/parser/graphql/union-commented.py

@@ -0,0 +1,65 @@
+# generated by datamodel-codegen:
+#   filename:  union-commented.graphql
+#   timestamp: 2019-07-26T00:00:00+00:00
+
+from __future__ import annotations
+
+from typing import Literal, Optional, TypeAlias, Union
+
+from pydantic import BaseModel, Field
+
+Boolean: TypeAlias = bool
+"""
+The `Boolean` scalar type represents `true` or `false`.
+"""
+
+
+String: TypeAlias = str
+"""
+The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
+"""
+
+
+class GroupMetadata(BaseModel):
+    """
+    This is a test comment in a single line
+    """
+
+    name: String
+    typename__: Optional[Literal['GroupMetadata']] = Field(
+        'GroupMetadata', alias='__typename'
+    )
+
+
+class Resource(BaseModel):
+    metadata: UserMetadata
+    typename__: Optional[Literal['Resource']] = Field('Resource', alias='__typename')
+
+
+class UserMetadata(BaseModel):
+    """
+    This is a multiline comment,
+    with a line break,
+    and a line break
+    """
+
+    name: String
+    typename__: Optional[Literal['UserMetadata']] = Field(
+        'UserMetadata', alias='__typename'
+    )
+
+
+# This is a single line comment
+DummyMetadata: TypeAlias = Union[
+    'GroupMetadata',
+    'UserMetadata',
+]
+
+
+# This is another multiline comment,
+# with a line break,
+# and another line break
+Metadata: TypeAlias = Union[
+    'GroupMetadata',
+    'UserMetadata',
+]

datamodel_code_generator-0.32.0/tests/data/expected/parser/openapi/openapi_parser_parse_allof_required_fields/output.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from typing import List
+
+from pydantic import BaseModel, Field
+
+
+class EmailMessage(BaseModel):
+    message: str = Field(..., description='The email message text.')
+    subject: str = Field(..., description='The subject line of the email.')
+    to: List[str] = Field(..., description='A list of email addresses.')

datamodel_code_generator-0.32.0/tests/data/expected/parser/openapi/openapi_parser_parse_anyof_required/output.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from typing import List, Optional
+
+from pydantic import BaseModel, Field
+
+
+class EmailMessage(BaseModel):
+    bcc: Optional[List[str]] = Field(
+        None, description='A list of "blind carbon copy" email addresses.'
+    )
+    cc: Optional[List[str]] = Field(
+        None, description='A list of "carbon copy" email addresses.'
+    )
+    message: str = Field(..., description='The email message text.')
+    subject: str = Field(..., description='The subject line of the email.')
+    to: Optional[List[str]] = Field(None, description='A list of email addresses.')

datamodel_code_generator-0.32.0/tests/data/expected/parser/openapi/openapi_parser_parse_required_null/output.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from enum import Enum
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+
+class Type(Enum):
+    my_first_object = 'my_first_object'
+    my_second_object = 'my_second_object'
+    my_third_object = 'my_third_object'
+
+
+class ObjectBase(BaseModel):
+    name: Optional[str] = Field(None, description='Name of the object')
+    type: Optional[Type] = Field(None, description='Object type')

{datamodel_code_generator-0.31.2 → datamodel_code_generator-0.32.0}/tests/data/expected/parser/openapi/openapi_parser_with_query_parameters/output.py

@@ -22,6 +22,10 @@ class PetForm(BaseModel):
     age: Optional[int] = None
 
 
+class PetsPetIdGetParametersQuery(BaseModel):
+    include: Optional[str] = None
+
+
 class Filter(BaseModel):
     type: Optional[str] = None
     color: Optional[str] = None

datamodel_code_generator-0.32.0/tests/data/expected/parser/openapi/openapi_parser_with_query_parameters/with_path_params.py

@@ -0,0 +1,66 @@
+from __future__ import annotations
+
+from enum import Enum
+from typing import List, Optional, Union
+
+from pydantic import BaseModel
+
+
+class Pet(BaseModel):
+    id: int
+    name: str
+    tag: Optional[str] = None
+
+
+class Error(BaseModel):
+    code: int
+    message: str
+
+
+class PetForm(BaseModel):
+    name: Optional[str] = None
+    age: Optional[int] = None
+
+
+class PetsPetIdGetParameters(BaseModel):
+    petId: str
+    include: Optional[str] = None
+
+
+class Filter(BaseModel):
+    type: Optional[str] = None
+    color: Optional[str] = None
+
+
+class MediaType(Enum):
+    xml = 'xml'
+    json = 'json'
+
+
+class MultipleMediaFilter(BaseModel):
+    type: Optional[str] = None
+    media_type: Optional[MediaType] = 'xml'
+
+
+class MultipleMediaFilter1(BaseModel):
+    type: Optional[str] = None
+    media_type: Optional[MediaType] = 'json'
+
+
+class PetsGetParameters(BaseModel):
+    limit: Optional[int] = 0
+    HomeAddress: Optional[str] = 'Unknown'
+    kind: Optional[str] = 'dog'
+    filter: Optional[Filter] = None
+    multipleMediaFilter: Optional[
+        Union[MultipleMediaFilter, MultipleMediaFilter1]
+    ] = None
+
+
+class PetsGetResponse(BaseModel):
+    __root__: List[Pet]
+
+
+class PetsPostRequest(BaseModel):
+    name: Optional[str] = None
+    age: Optional[int] = None

datamodel_code_generator-0.32.0/tests/data/graphql/union-commented.graphql

@@ -0,0 +1,25 @@
+"""This is a test comment in a single line"""
+type GroupMetadata {
+  name: String!
+}
+
+"""This is a multiline comment,
+with a line break,
+and a line break
+"""
+type UserMetadata {
+  name: String!
+}
+
+"""This is another multiline comment,
+with a line break,
+and another line break
+"""
+union Metadata = UserMetadata | GroupMetadata
+
+"""This is a single line comment"""
+union DummyMetadata = UserMetadata | GroupMetadata
+
+type Resource {
+  metadata: UserMetadata!
+}

datamodel_code_generator-0.32.0/tests/data/jsonschema/treat_dot_as_module/complex.directory/api.path.basic_enum.json

@@ -0,0 +1,25 @@
+{
+  "definitions": {
+    "ProcessingStatus": {
+      "title": "ProcessingStatus",
+      "enum": [
+        "COMPLETED",
+        "PENDING",
+        "FAILED"
+      ],
+      "type": "string",
+      "description": "The processing status"
+    }
+  },
+  "properties": {
+    "processing_status": {
+      "$ref": "#/definitions/ProcessingStatus",
+      "default": "COMPLETED"
+    },
+    "name": {
+      "type": "string"
+    }
+  },  
+  "title": "Basic Enum",
+  "type": "object"
+}

datamodel_code_generator-0.32.0/tests/data/openapi/allof_required_fields.yaml

@@ -0,0 +1,25 @@
+openapi: "3.0.0"
+components:
+  schemas:
+    EmailMessage:
+      title: Email message
+      description: |
+        An email message. There must be at least one recipient in `to`, `cc`, or `bcc`.
+      type: object
+      required:
+        - allOf:
+            - message
+            - subject
+            - to
+      properties:
+        message:
+          type: string
+          description: The email message text.
+        subject:
+          type: string
+          description: The subject line of the email.
+        to:
+          type: array
+          description: A list of email addresses.
+          items:
+            type: string

datamodel_code_generator-0.32.0/tests/data/openapi/anyof_required.yaml

@@ -0,0 +1,37 @@
+openapi: "3.0.0"
+components:
+  schemas:
+    EmailMessage:
+      title: Email message
+      description: |
+        An email message. There must be at least one recipient in `to`, `cc`, or `bcc`.
+      type: object
+      required:
+        - message
+        - subject
+        - anyOf:
+            - to
+            - cc
+            - bcc
+      properties:
+        bcc:
+          type: array
+          items:
+            type: string
+          description: A list of "blind carbon copy" email addresses.
+        cc:
+          type: array
+          items:
+            type: string
+          description: A list of "carbon copy" email addresses.
+        message:
+          type: string
+          description: The email message text.
+        subject:
+          type: string
+          description: The subject line of the email.
+        to:
+          type: array
+          description: A list of email addresses.
+          items:
+            type: string

{datamodel_code_generator-0.31.2 → datamodel_code_generator-0.32.0}/tests/data/openapi/query_parameters.yaml

@@ -14,6 +14,30 @@ servers:
 security:
   - BearerAuth: []
 paths:
+  /pets/{petId}:
+    get:
+      summary: Get a pet by ID
+      operationId: getPet
+      parameters:
+        - name: petId
+          in: path
+          required: true
+          description: The pet ID
+          schema:
+            type: string
+        - name: include
+          in: query
+          required: false
+          description: Include additional data
+          schema:
+            type: string
+      responses:
+        '200':
+          description: A pet
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Pet"
   /pets:
     get:
       summary: List all pets