datamodel-code-generator 0.19.0__tar.gz → 0.20.0__tar.gz

{datamodel_code_generator-0.19.0 → datamodel_code_generator-0.20.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: datamodel-code-generator
-Version: 0.19.0
+Version: 0.20.0
 Summary: Datamodel Code Generator
 Home-page: https://github.com/koxudaxi/datamodel-code-generator
 License: MIT
@@ -16,12 +16,6 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Provides-Extra: http
 Requires-Dist: PySnooper (>=0.4.1,<2.0.0)
@@ -32,7 +26,7 @@ Requires-Dist: httpx ; extra == "http"
 Requires-Dist: inflect (>=4.1.0,<6.0)
 Requires-Dist: isort (>=4.3.21,<6.0)
 Requires-Dist: jinja2 (>=2.10.1,<4.0)
-Requires-Dist: openapi-spec-validator (>=0.2.8,<=0.5.1)
+Requires-Dist: openapi-spec-validator (>=0.2.8,<=0.5.2)
 Requires-Dist: packaging
 Requires-Dist: prance (>=0.18.2,<1.0)
 Requires-Dist: pydantic[email] (>=1.10.0,<2.0.0) ; python_version >= "3.11" and python_version < "4.0"
@@ -44,7 +38,7 @@ Description-Content-Type: text/markdown
 
 # datamodel-code-generator
 
-This code generator creates [pydantic](https://docs.pydantic.dev/) model and [dataclasses.dataclass](https://docs.python.org/3/library/dataclasses.html) from an openapi file and others.
+This code generator creates [pydantic](https://docs.pydantic.dev/) model, [dataclasses.dataclass](https://docs.python.org/3/library/dataclasses.html) and [typing.TypedDict](https://docs.python.org/3/library/typing.html#typing.TypedDict) from an openapi file and others.
 
 [![Build Status](https://github.com/koxudaxi/datamodel-code-generator/workflows/Test/badge.svg)](https://github.com/koxudaxi/datamodel-code-generator/actions?query=workflow%3ATest)
 [![PyPI version](https://badge.fury.io/py/datamodel-code-generator.svg)](https://pypi.python.org/pypi/datamodel-code-generator)
@@ -69,7 +63,7 @@ To install `datamodel-code-generator`:
 $ pip install datamodel-code-generator
 ```
 
-## Simple usage
+## Simple Usage
 You can generate models from a local file.
 ```bash
 $ datamodel-codegen --input api.yaml --output model.py
@@ -279,14 +273,14 @@ class Apis(BaseModel):
 ```
 </details>
 
-## Which project uses it?
-These OSS use datamodel-code-generator to generate many models. We can learn about use-cases from these projects.
+## Projects that use datamodel-code-generator
+These OSS projects use datamodel-code-generator to generate many models. See the following linked projects for real world examples and inspiration.
 - [Netflix/consoleme](https://github.com/Netflix/consoleme)
   - *[How do I generate models from the Swagger specification?](https://github.com/Netflix/consoleme/blob/master/docs/gitbook/faq.md#how-do-i-generate-models-from-the-swagger-specification)*
 - [DataDog/integrations-core](https://github.com/DataDog/integrations-core)
   - *[Config models](https://github.com/DataDog/integrations-core/blob/master/docs/developer/meta/config-models.md)*
 - [awslabs/aws-lambda-powertools-python](https://github.com/awslabs/aws-lambda-powertools-python)
-  - *Not used. But, introduced [advanced-use-cases](https://awslabs.github.io/aws-lambda-powertools-python/2.6.0/utilities/parser/#advanced-use-cases) in the official document*
+  - *Recommended for [advanced-use-cases](https://awslabs.github.io/aws-lambda-powertools-python/2.6.0/utilities/parser/#advanced-use-cases) in the official documentation*
 - [open-metadata/OpenMetadata](https://github.com/open-metadata/OpenMetadata)
   - [Makefile](https://github.com/open-metadata/OpenMetadata/blob/main/Makefile)
 - [airbytehq/airbyte](https://github.com/airbytehq/airbyte)
@@ -304,6 +298,7 @@ These OSS use datamodel-code-generator to generate many models. We can learn abo
 ## Supported output types
 - [pydantic](https://docs.pydantic.dev/).BaseModel
 - [dataclasses.dataclass](https://docs.python.org/3/library/dataclasses.html)
+- [typing.TypedDict](https://docs.python.org/3/library/typing.html#typing.TypedDict)
 
 ## Installation
 
@@ -329,7 +324,7 @@ You can genearte models from a URL.
 ```bash
 $ datamodel-codegen --url https://<INPUT FILE URL> --output model.py
 ```
-This method needs  [http extra option](#http-extra-option)
+This method needs the [http extra option](#http-extra-option)
 
 
 ## All Command Options
@@ -340,7 +335,7 @@ usage: datamodel-codegen [-h] [--input INPUT] [--url URL]
                          [--http-headers HTTP_HEADER [HTTP_HEADER ...]]
                          [--http-ignore-tls]
                          [--input-file-type {auto,openapi,jsonschema,json,yaml,dict,csv}]
-                         [--output-model-type {pydantic.BaseModel,dataclasses.dataclass}]
+                         [--output-model-type {pydantic.BaseModel,dataclasses.dataclass,typing.TypedDict}]
                          [--openapi-scopes {schemas,paths,tags,parameters} [{schemas,paths,tags,parameters} ...]]
                          [--output OUTPUT] [--base-class BASE_CLASS]
                          [--field-constraints] [--use-annotated]
@@ -391,7 +386,7 @@ options:
                         certificate
   --input-file-type {auto,openapi,jsonschema,json,yaml,dict,csv}
                         Input file type (default: auto)
-  --output-model-type {pydantic.BaseModel,dataclasses.dataclass}
+  --output-model-type {pydantic.BaseModel,dataclasses.dataclass,typing.TypedDict}
                         Output model type (default: pydantic.BaseModel)
   --openapi-scopes {schemas,paths,tags,parameters} [{schemas,paths,tags,parameters} ...]
                         Scopes of OpenAPI model generation (default: schemas)
@@ -497,41 +492,6 @@ options:
   --version             show version
 ```
 
-
-## Implemented list
-### OpenAPI 3 and JsonSchema
-#### DataType
--  string (include patter/minLength/maxLenght)
--  number (include maximum/exclusiveMaximum/minimum/exclusiveMinimum/multipleOf/le/ge)
--  integer (include maximum/exclusiveMaximum/minimum/exclusiveMinimum/multipleOf/le/ge)
--  boolean
--  array
--  object
-
-##### String Format
--  date
--  datetime
--  time
--  password
--  email
--  idn-email
--  uuid (uuid1/uuid2/uuid3/uuid4/uuid5)
--  ipv4
--  ipv6
--  ipv4-network
--  ipv6-network
--  hostname
--  decimal
-
-#### Other schema
--  enum (as enum.Enum or typing.Literal)
--  allOf (as Multiple inheritance)
--  anyOf (as typing.Union)
--  oneOf (as typing.Union)
--  $ref ([http extra](#http-extra-option) is required when resolving $ref for remote files.)
--  $id (for [JSONSchema](https://json-schema.org/understanding-json-schema/structuring.html#the-id-property))
-
-
 ## Related projects
 ### fastapi-code-generator
 This code generator creates [FastAPI](https://github.com/tiangolo/fastapi) app from an openapi file.

{datamodel_code_generator-0.19.0 → datamodel_code_generator-0.20.0}/README.md

@@ -1,6 +1,6 @@
 # datamodel-code-generator
 
-This code generator creates [pydantic](https://docs.pydantic.dev/) model and [dataclasses.dataclass](https://docs.python.org/3/library/dataclasses.html) from an openapi file and others.
+This code generator creates [pydantic](https://docs.pydantic.dev/) model, [dataclasses.dataclass](https://docs.python.org/3/library/dataclasses.html) and [typing.TypedDict](https://docs.python.org/3/library/typing.html#typing.TypedDict) from an openapi file and others.
 
 [![Build Status](https://github.com/koxudaxi/datamodel-code-generator/workflows/Test/badge.svg)](https://github.com/koxudaxi/datamodel-code-generator/actions?query=workflow%3ATest)
 [![PyPI version](https://badge.fury.io/py/datamodel-code-generator.svg)](https://pypi.python.org/pypi/datamodel-code-generator)
@@ -25,7 +25,7 @@ To install `datamodel-code-generator`:
 $ pip install datamodel-code-generator
 ```
 
-## Simple usage
+## Simple Usage
 You can generate models from a local file.
 ```bash
 $ datamodel-codegen --input api.yaml --output model.py
@@ -235,14 +235,14 @@ class Apis(BaseModel):
 ```
 </details>
 
-## Which project uses it?
-These OSS use datamodel-code-generator to generate many models. We can learn about use-cases from these projects.
+## Projects that use datamodel-code-generator
+These OSS projects use datamodel-code-generator to generate many models. See the following linked projects for real world examples and inspiration.
 - [Netflix/consoleme](https://github.com/Netflix/consoleme)
   - *[How do I generate models from the Swagger specification?](https://github.com/Netflix/consoleme/blob/master/docs/gitbook/faq.md#how-do-i-generate-models-from-the-swagger-specification)*
 - [DataDog/integrations-core](https://github.com/DataDog/integrations-core)
   - *[Config models](https://github.com/DataDog/integrations-core/blob/master/docs/developer/meta/config-models.md)*
 - [awslabs/aws-lambda-powertools-python](https://github.com/awslabs/aws-lambda-powertools-python)
-  - *Not used. But, introduced [advanced-use-cases](https://awslabs.github.io/aws-lambda-powertools-python/2.6.0/utilities/parser/#advanced-use-cases) in the official document*
+  - *Recommended for [advanced-use-cases](https://awslabs.github.io/aws-lambda-powertools-python/2.6.0/utilities/parser/#advanced-use-cases) in the official documentation*
 - [open-metadata/OpenMetadata](https://github.com/open-metadata/OpenMetadata)
   - [Makefile](https://github.com/open-metadata/OpenMetadata/blob/main/Makefile)
 - [airbytehq/airbyte](https://github.com/airbytehq/airbyte)
@@ -260,6 +260,7 @@ These OSS use datamodel-code-generator to generate many models. We can learn abo
 ## Supported output types
 - [pydantic](https://docs.pydantic.dev/).BaseModel
 - [dataclasses.dataclass](https://docs.python.org/3/library/dataclasses.html)
+- [typing.TypedDict](https://docs.python.org/3/library/typing.html#typing.TypedDict)
 
 ## Installation
 
@@ -285,7 +286,7 @@ You can genearte models from a URL.
 ```bash
 $ datamodel-codegen --url https://<INPUT FILE URL> --output model.py
 ```
-This method needs  [http extra option](#http-extra-option)
+This method needs the [http extra option](#http-extra-option)
 
 
 ## All Command Options
@@ -296,7 +297,7 @@ usage: datamodel-codegen [-h] [--input INPUT] [--url URL]
                          [--http-headers HTTP_HEADER [HTTP_HEADER ...]]
                          [--http-ignore-tls]
                          [--input-file-type {auto,openapi,jsonschema,json,yaml,dict,csv}]
-                         [--output-model-type {pydantic.BaseModel,dataclasses.dataclass}]
+                         [--output-model-type {pydantic.BaseModel,dataclasses.dataclass,typing.TypedDict}]
                          [--openapi-scopes {schemas,paths,tags,parameters} [{schemas,paths,tags,parameters} ...]]
                          [--output OUTPUT] [--base-class BASE_CLASS]
                          [--field-constraints] [--use-annotated]
@@ -347,7 +348,7 @@ options:
                         certificate
   --input-file-type {auto,openapi,jsonschema,json,yaml,dict,csv}
                         Input file type (default: auto)
-  --output-model-type {pydantic.BaseModel,dataclasses.dataclass}
+  --output-model-type {pydantic.BaseModel,dataclasses.dataclass,typing.TypedDict}
                         Output model type (default: pydantic.BaseModel)
   --openapi-scopes {schemas,paths,tags,parameters} [{schemas,paths,tags,parameters} ...]
                         Scopes of OpenAPI model generation (default: schemas)
@@ -453,41 +454,6 @@ options:
   --version             show version
 ```
 
-
-## Implemented list
-### OpenAPI 3 and JsonSchema
-#### DataType
--  string (include patter/minLength/maxLenght)
--  number (include maximum/exclusiveMaximum/minimum/exclusiveMinimum/multipleOf/le/ge)
--  integer (include maximum/exclusiveMaximum/minimum/exclusiveMinimum/multipleOf/le/ge)
--  boolean
--  array
--  object
-
-##### String Format
--  date
--  datetime
--  time
--  password
--  email
--  idn-email
--  uuid (uuid1/uuid2/uuid3/uuid4/uuid5)
--  ipv4
--  ipv6
--  ipv4-network
--  ipv6-network
--  hostname
--  decimal
-
-#### Other schema
--  enum (as enum.Enum or typing.Literal)
--  allOf (as Multiple inheritance)
--  anyOf (as typing.Union)
--  oneOf (as typing.Union)
--  $ref ([http extra](#http-extra-option) is required when resolving $ref for remote files.)
--  $id (for [JSONSchema](https://json-schema.org/understanding-json-schema/structuring.html#the-id-property))
-
-
 ## Related projects
 ### fastapi-code-generator
 This code generator creates [FastAPI](https://github.com/tiangolo/fastapi) app from an openapi file.

{datamodel_code_generator-0.19.0 → datamodel_code_generator-0.20.0}/datamodel_code_generator/__init__.py

@@ -220,6 +220,7 @@ RAW_DATA_TYPES: List[InputFileType] = [
 class DataModelType(Enum):
     PydanticBaseModel = 'pydantic.BaseModel'
     DataclassesDataclass = 'dataclasses.dataclass'
+    TypingTypedDict = 'typing.TypedDict'
 
 
 class OpenAPIScope(Enum):
@@ -314,6 +315,7 @@ def generate(
     capitalise_enum_members: bool = False,
     keep_model_order: bool = False,
     custom_file_header: Optional[str] = None,
+    custom_file_header_path: Optional[Path] = None,
 ) -> None:
     remote_text_cache: DefaultPutDict[str, str] = DefaultPutDict()
     if isinstance(input_, str):
@@ -397,7 +399,7 @@ def generate(
 
     from datamodel_code_generator.model import get_data_model_types
 
-    data_model_types = get_data_model_types(output_model_type)
+    data_model_types = get_data_model_types(output_model_type, target_python_version)
     parser = parser_class(
         source=input_text or input_,
         data_model_type=data_model_types.data_model,
@@ -427,7 +429,9 @@ def generate(
         use_field_description=use_field_description,
         use_default_kwarg=use_default_kwarg,
         reuse_model=reuse_model,
-        enum_field_as_literal=enum_field_as_literal,
+        enum_field_as_literal=LiteralType.All
+        if output_model_type == DataModelType.TypingTypedDict
+        else enum_field_as_literal,
         use_one_literal_as_default=use_one_literal_as_default,
         set_default_enum_member=set_default_enum_member,
         use_subclass_enum=use_subclass_enum,
@@ -488,6 +492,9 @@ def generate(
 
     timestamp = datetime.now(timezone.utc).replace(microsecond=0).isoformat()
 
+    if custom_file_header is None and custom_file_header_path:
+        custom_file_header = custom_file_header_path.read_text(encoding=encoding)
+
     header = """\
 # generated by datamodel-codegen:
 #   filename:  {}"""
@@ -497,8 +504,7 @@ def generate(
         header += f'\n#   version:   {get_version()}'
 
     file: Optional[IO[Any]]
-    for path, body_and_filename in modules.items():
-        body, filename = body_and_filename
+    for path, (body, filename) in modules.items():
         if path is None:
             file = None
         else:

{datamodel_code_generator-0.19.0 → datamodel_code_generator-0.20.0}/datamodel_code_generator/__main__.py

@@ -433,6 +433,15 @@ arg_parser.add_argument(
 arg_parser.add_argument(
     '--custom-file-header', help='Custom file header', type=str, default=None
 )
+
+arg_parser.add_argument(
+    '--custom-file-header-path',
+    help='Custom file header file path',
+    default=None,
+    type=str,
+)
+
+
 arg_parser.add_argument('--version', help='show version', action='store_true')
 
 
@@ -448,7 +457,9 @@ class Config(BaseModel):
             return value
         return cast(TextIOBase, Path(value).expanduser().resolve().open('rt'))
 
-    @validator('input', 'output', 'custom_template_dir', pre=True)
+    @validator(
+        'input', 'output', 'custom_template_dir', 'custom_file_header_path', pre=True
+    )
     def validate_path(cls, value: Any) -> Optional[Path]:
         if value is None or isinstance(value, Path):
             return value  # pragma: no cover
@@ -488,6 +499,14 @@ class Config(BaseModel):
                 )
         return values
 
+    @root_validator
+    def validate_custom_file_header(cls, values: Dict[str, Any]) -> Dict[str, Any]:
+        if values.get('custom_file_header') and values.get('custom_file_header_path'):
+            raise Error(
+                '`--custom_file_header_path` can not be used with `--custom_file_header`.'
+            )  # pragma: no cover
+        return values
+
     # Pydantic 1.5.1 doesn't support each_item=True correctly
     @validator('http_headers', pre=True)
     def validate_http_headers(cls, value: Any) -> Optional[List[Tuple[str, str]]]:
@@ -583,6 +602,7 @@ class Config(BaseModel):
     capitalise_enum_members: bool = False
     keep_model_order: bool = False
     custom_file_header: Optional[str] = None
+    custom_file_header_path: Optional[Path] = None
 
     def merge_args(self, args: Namespace) -> None:
         set_args = {
@@ -742,6 +762,8 @@ def main(args: Optional[Sequence[str]] = None) -> Exit:
             remove_special_field_name_prefix=config.remove_special_field_name_prefix,
             capitalise_enum_members=config.capitalise_enum_members,
             keep_model_order=config.keep_model_order,
+            custom_file_header=config.custom_file_header,
+            custom_file_header_path=config.custom_file_header_path,
         )
         return Exit.OK
     except InvalidClassNameError as e:

{datamodel_code_generator-0.19.0 → datamodel_code_generator-0.20.0}/datamodel_code_generator/format.py

@@ -9,6 +9,8 @@ import black
 import isort
 import toml
 
+from datamodel_code_generator import cached_property
+
 
 class PythonVersion(Enum):
     PY_36 = '3.6'
@@ -18,17 +20,41 @@ class PythonVersion(Enum):
     PY_310 = '3.10'
     PY_311 = '3.11'
 
+    @cached_property
+    def _is_py_38_or_later(self) -> bool:  # pragma: no cover
+        return self.value not in {self.PY_36.value, self.PY_37.value}  # type: ignore
+
+    @cached_property
+    def _is_py_39_or_later(self) -> bool:  # pragma: no cover
+        return self.value not in {self.PY_36.value, self.PY_37.value, self.PY_38.value}  # type: ignore
+
+    @cached_property
+    def _is_py_310_or_later(self) -> bool:  # pragma: no cover
+        return self.value not in {self.PY_36.value, self.PY_37.value, self.PY_38.value, self.PY_39.value}  # type: ignore
+
+    @cached_property
+    def _is_py_311_or_later(self) -> bool:  # pragma: no cover
+        return self.value not in {self.PY_36.value, self.PY_37.value, self.PY_38.value, self.PY_39.value, self.PY_310.value}  # type: ignore
+
     @property
     def has_literal_type(self) -> bool:
-        return self.value not in {self.PY_36.value, self.PY_37.value}  # type: ignore
+        return self._is_py_38_or_later
 
     @property
     def has_union_operator(self) -> bool:  # pragma: no cover
-        return self.value not in {self.PY_36.value, self.PY_37.value, self.PY_38.value, self.PY_39.value}  # type: ignore
+        return self._is_py_310_or_later
 
     @property
     def has_annotated_type(self) -> bool:
-        return self.value not in {self.PY_36.value, self.PY_37.value, self.PY_38.value}  # type: ignore
+        return self._is_py_39_or_later
+
+    @property
+    def has_typed_dict(self) -> bool:
+        return self._is_py_38_or_later
+
+    @property
+    def has_typed_dict_non_required(self) -> bool:
+        return self._is_py_311_or_later
 
 
 if TYPE_CHECKING:

{datamodel_code_generator-0.19.0 → datamodel_code_generator-0.20.0}/datamodel_code_generator/model/__init__.py

@@ -6,7 +6,7 @@ from ..types import DataTypeManager as DataTypeManagerABC
 from .base import ConstraintsBase, DataModel, DataModelFieldBase
 
 if TYPE_CHECKING:
-    from .. import DataModelType
+    from .. import DataModelType, PythonVersion
 
 
 class DataModelSet(NamedTuple):
@@ -17,9 +17,11 @@ class DataModelSet(NamedTuple):
     dump_resolve_reference_action: Optional[Callable[[Iterable[str]], str]]
 
 
-def get_data_model_types(data_model_type: DataModelType) -> DataModelSet:
+def get_data_model_types(
+    data_model_type: DataModelType, target_python_version: PythonVersion
+) -> DataModelSet:
     from .. import DataModelType
-    from . import dataclass, pydantic, rootmodel
+    from . import dataclass, pydantic, rootmodel, typed_dict
     from .types import DataTypeManager
 
     if data_model_type == DataModelType.PydanticBaseModel:
@@ -38,6 +40,18 @@ def get_data_model_types(data_model_type: DataModelType) -> DataModelSet:
             data_type_manager=DataTypeManager,
             dump_resolve_reference_action=None,
         )
+    elif data_model_type == DataModelType.TypingTypedDict:
+        return DataModelSet(
+            data_model=typed_dict.TypedDict
+            if target_python_version.has_typed_dict
+            else typed_dict.TypedDictBackport,
+            root_model=rootmodel.RootModel,
+            field_model=typed_dict.DataModelField
+            if target_python_version.has_typed_dict_non_required
+            else typed_dict.DataModelFieldBackport,
+            data_type_manager=DataTypeManager,
+            dump_resolve_reference_action=None,
+        )
     raise ValueError(
         f'{data_model_type} is unsupported data model type'
     )  # pragma: no cover

datamodel_code_generator-0.20.0/datamodel_code_generator/model/improts.py

@@ -0,0 +1,8 @@
+from datamodel_code_generator.imports import Import
+
+IMPORT_DATACLASS = Import.from_full_path('dataclasses.dataclass')
+IMPORT_FIELD = Import.from_full_path('dataclasses.field')
+IMPORT_TYPED_DICT = Import.from_full_path('typing.TypedDict')
+IMPORT_TYPED_DICT_BACKPORT = Import.from_full_path('typing_extensions.TypedDict')
+IMPORT_NOT_REQUIRED = Import.from_full_path('typing.NotRequired')
+IMPORT_NOT_REQUIRED_BACKPORT = Import.from_full_path('typing_extensions.NotRequired')

datamodel_code_generator-0.20.0/datamodel_code_generator/model/template/TypedDict.jinja2

@@ -0,0 +1,5 @@
+{%- if is_functional_syntax %}
+{% include 'TypedDictFunction.jinja2' %}
+{%- else %}
+{% include 'TypedDictClass.jinja2' %}
+{%- endif %}

datamodel_code_generator-0.20.0/datamodel_code_generator/model/template/TypedDictClass.jinja2

@@ -0,0 +1,17 @@
+class {{ class_name }}({{ base_class }}):
+{%- if description %}
+    """
+    {{ description | indent(4) }}
+    """
+{%- endif %}
+{%- if not fields and not description %}
+    pass
+{%- endif %}
+{%- for field in fields %}
+    {{ field.name }}: {{ field.type_hint }}
+    {%- if field.docstring %}
+    """
+    {{ field.docstring | indent(4) }}
+    """
+    {%- endif %}
+{%- endfor -%}

datamodel_code_generator-0.20.0/datamodel_code_generator/model/template/TypedDictFunction.jinja2

@@ -0,0 +1,16 @@
+{%- if description %}
+"""
+{{ description | indent(4) }}
+"""
+{%- endif %}
+{{ class_name }} = TypedDict('{{ class_name }}', {
+{%- for field in all_fields %}
+    '{{ field.key }}': {{ field.type_hint }},
+    {%- if field.docstring %}
+    """
+    {{ field.docstring | indent(4) }}
+    """
+    {%- endif %}
+{%- endfor -%}
+})
+

datamodel_code_generator-0.20.0/datamodel_code_generator/model/typed_dict.py

@@ -0,0 +1,151 @@
+from __future__ import annotations
+
+import keyword
+from pathlib import Path
+from typing import (
+    Any,
+    ClassVar,
+    DefaultDict,
+    Dict,
+    Iterator,
+    List,
+    Optional,
+    Tuple,
+)
+
+from datamodel_code_generator.imports import Import
+from datamodel_code_generator.model import DataModel, DataModelFieldBase
+from datamodel_code_generator.model.base import UNDEFINED
+from datamodel_code_generator.model.improts import (
+    IMPORT_NOT_REQUIRED,
+    IMPORT_NOT_REQUIRED_BACKPORT,
+    IMPORT_TYPED_DICT,
+    IMPORT_TYPED_DICT_BACKPORT,
+)
+from datamodel_code_generator.reference import Reference
+from datamodel_code_generator.types import NOT_REQUIRED_PREFIX
+
+escape_characters = str.maketrans(
+    {
+        '\\': r'\\',
+        "'": r"\'",
+        '\b': r'\b',
+        '\f': r'\f',
+        '\n': r'\n',
+        '\r': r'\r',
+        '\t': r'\t',
+    }
+)
+
+
+def _is_valid_field_name(field: DataModelFieldBase) -> bool:
+    name = field.original_name or field.name
+    if name is None:  # pragma: no cover
+        return False
+    return name.isidentifier() and not keyword.iskeyword(name)
+
+
+class TypedDict(DataModel):
+    TEMPLATE_FILE_PATH: ClassVar[str] = 'TypedDict.jinja2'
+    BASE_CLASS: ClassVar[str] = 'typing.TypedDict'
+    DEFAULT_IMPORTS: ClassVar[Tuple[Import, ...]] = (IMPORT_TYPED_DICT,)
+
+    def __init__(
+        self,
+        *,
+        reference: Reference,
+        fields: List[DataModelFieldBase],
+        decorators: Optional[List[str]] = None,
+        base_classes: Optional[List[Reference]] = None,
+        custom_base_class: Optional[str] = None,
+        custom_template_dir: Optional[Path] = None,
+        extra_template_data: Optional[DefaultDict[str, Dict[str, Any]]] = None,
+        methods: Optional[List[str]] = None,
+        path: Optional[Path] = None,
+        description: Optional[str] = None,
+        default: Any = UNDEFINED,
+        nullable: bool = False,
+    ) -> None:
+        super().__init__(
+            reference=reference,
+            fields=fields,
+            decorators=decorators,
+            base_classes=base_classes,
+            custom_base_class=custom_base_class,
+            custom_template_dir=custom_template_dir,
+            extra_template_data=extra_template_data,
+            methods=methods,
+            path=path,
+            description=description,
+            default=default,
+            nullable=nullable,
+        )
+
+    @property
+    def is_functional_syntax(self) -> bool:
+        return any(not _is_valid_field_name(f) for f in self.fields)
+
+    @property
+    def all_fields(self) -> Iterator[DataModelFieldBase]:
+        for base_class in self.base_classes:
+            if base_class.reference is None:  # pragma: no cover
+                continue
+            data_model = base_class.reference.source
+            if not isinstance(data_model, DataModel):  # pragma: no cover
+                continue
+
+            if isinstance(data_model, TypedDict):  # pragma: no cover
+                yield from data_model.all_fields
+
+        yield from self.fields
+
+    def render(self, *, class_name: Optional[str] = None) -> str:
+        response = self._render(
+            class_name=class_name or self.class_name,
+            fields=self.fields,
+            decorators=self.decorators,
+            base_class=self.base_class,
+            methods=self.methods,
+            description=self.description,
+            is_functional_syntax=self.is_functional_syntax,
+            all_fields=self.all_fields,
+            **self.extra_template_data,
+        )
+        return response
+
+
+class TypedDictBackport(TypedDict):
+    BASE_CLASS: ClassVar[str] = 'typing_extensions.TypedDict'
+    DEFAULT_IMPORTS: ClassVar[Tuple[Import, ...]] = (IMPORT_TYPED_DICT_BACKPORT,)
+
+
+class DataModelField(DataModelFieldBase):
+    DEFAULT_IMPORTS: ClassVar[Tuple[Import, ...]] = (IMPORT_NOT_REQUIRED,)
+
+    @property
+    def key(self) -> str:
+        return (self.original_name or self.name or '').translate(  # pragma: no cover
+            escape_characters
+        )
+
+    @property
+    def type_hint(self) -> str:
+        type_hint = super().type_hint
+        if self._not_required:
+            return f'{NOT_REQUIRED_PREFIX}{type_hint}]'
+        return type_hint
+
+    @property
+    def _not_required(self) -> bool:
+        return not self.required and isinstance(self.parent, TypedDict)
+
+    @property
+    def imports(self) -> Tuple[Import, ...]:
+        return (
+            *super().imports,
+            *(self.DEFAULT_IMPORTS if self._not_required else ()),
+        )
+
+
+class DataModelFieldBackport(DataModelField):
+    DEFAULT_IMPORTS: ClassVar[Tuple[Import, ...]] = (IMPORT_NOT_REQUIRED_BACKPORT,)

{datamodel_code_generator-0.19.0 → datamodel_code_generator-0.20.0}/datamodel_code_generator/parser/base.py

@@ -485,12 +485,7 @@ class Parser(ABC):
             yield Source(path=Path(), text=self.source)
         elif isinstance(self.source, Path):  # pragma: no cover
             if self.source.is_dir():
-                paths = (
-                    sorted(self.source.rglob('*'))
-                    if self.keep_model_order
-                    else self.source.rglob('*')
-                )
-                for path in paths:
+                for path in sorted(self.source.rglob('*'), key=lambda p: p.name):
                     if path.is_file():
                         yield Source.from_path(path, self.base_path, self.encoding)
             else:

{datamodel_code_generator-0.19.0 → datamodel_code_generator-0.20.0}/datamodel_code_generator/parser/jsonschema.py

@@ -226,6 +226,7 @@ class JsonSchemaObject(BaseModel):
     default: Any
     id: Optional[str] = Field(default=None, alias='$id')
     custom_type_path: Optional[str] = Field(default=None, alias='customTypePath')
+    custom_base_path: Optional[str] = Field(default=None, alias='customBasePath')
     extras: Dict[str, Any] = Field(alias=__extra_key__, default_factory=dict)
     discriminator: Union[Discriminator, str, None]
 
@@ -663,7 +664,7 @@ class JsonSchemaParser(Parser):
             reference=reference,
             fields=fields,
             base_classes=base_classes,
-            custom_base_class=self.base_class,
+            custom_base_class=obj.custom_base_path or self.base_class,
             custom_template_dir=self.custom_template_dir,
             extra_template_data=self.extra_template_data,
             path=self.current_source_path,
@@ -781,7 +782,7 @@ class JsonSchemaParser(Parser):
         data_model_root = self.data_model_root_type(
             reference=reference,
             fields=[field],
-            custom_base_class=self.base_class,
+            custom_base_class=obj.custom_base_path or self.base_class,
             custom_template_dir=self.custom_template_dir,
             extra_template_data=self.extra_template_data,
             path=self.current_source_path,
@@ -903,7 +904,7 @@ class JsonSchemaParser(Parser):
         data_model_type = data_model_type_class(
             reference=reference,
             fields=fields,
-            custom_base_class=self.base_class,
+            custom_base_class=obj.custom_base_path or self.base_class,
             custom_template_dir=self.custom_template_dir,
             extra_template_data=self.extra_template_data,
             path=self.current_source_path,
@@ -1153,7 +1154,7 @@ class JsonSchemaParser(Parser):
         data_model_root = self.data_model_root_type(
             reference=reference,
             fields=[field],
-            custom_base_class=self.base_class,
+            custom_base_class=obj.custom_base_path or self.base_class,
             custom_template_dir=self.custom_template_dir,
             extra_template_data=self.extra_template_data,
             path=self.current_source_path,
@@ -1233,7 +1234,7 @@ class JsonSchemaParser(Parser):
                     has_default=obj.has_default,
                 )
             ],
-            custom_base_class=self.base_class,
+            custom_base_class=obj.custom_base_path or self.base_class,
             custom_template_dir=self.custom_template_dir,
             extra_template_data=self.extra_template_data,
             path=self.current_source_path,
@@ -1366,7 +1367,7 @@ class JsonSchemaParser(Parser):
                     original_name=None,
                 )
             ],
-            custom_base_class=self.base_class,
+            custom_base_class=obj.custom_base_path or self.base_class,
             custom_template_dir=self.custom_template_dir,
             extra_template_data=self.extra_template_data,
             path=self.current_source_path,
@@ -1623,6 +1624,8 @@ class JsonSchemaParser(Parser):
                 path, obj_name, unique=False, class_name=True
             ).name
             with self.root_id_context(raw):
+                # Some jsonschema docs include attribute self to have include version details
+                raw.pop('self', None)
                 # parse $id before parsing $ref
                 root_obj = JsonSchemaObject.parse_obj(raw)
                 self.parse_id(root_obj, path_parts)

{datamodel_code_generator-0.19.0 → datamodel_code_generator-0.20.0}/datamodel_code_generator/parser/openapi.py

@@ -555,6 +555,9 @@ class OpenAPIParser(JsonSchemaParser):
                 ]
                 paths_path = [*path_parts, '#/paths']
                 for path_name, methods in paths.items():
+                    # Resolve path items if applicable
+                    if '$ref' in methods:
+                        methods = self.get_ref_model(methods['$ref'])
                     paths_parameters = parameters[:]
                     if 'parameters' in methods:
                         paths_parameters.extend(methods['parameters'])

{datamodel_code_generator-0.19.0 → datamodel_code_generator-0.20.0}/datamodel_code_generator/types.py

@@ -68,6 +68,9 @@ STANDARD_DICT = 'dict'
 STANDARD_LIST = 'list'
 STR = 'str'
 
+NOT_REQUIRED = 'NotRequired'
+NOT_REQUIRED_PREFIX = f'{NOT_REQUIRED}['
+
 
 class StrictTypes(Enum):
     str = 'str'

datamodel_code_generator-0.20.0/datamodel_code_generator/version.py

@@ -0,0 +1 @@
+version: str = '0.20.0'

{datamodel_code_generator-0.19.0 → datamodel_code_generator-0.20.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "datamodel-code-generator"
-version = "0.19.0"
+version = "0.20.0"
 description = "Datamodel Code Generator"
 authors = ["Koudai Aono <koxudaxi@gmail.com>"]
 readme = "README.md"
@@ -48,7 +48,7 @@ pydantic =  [
 ]
 argcomplete = ">=1.10,<4.0"
 prance = ">=0.18.2,<1.0"
-openapi-spec-validator = ">=0.2.8,<=0.5.1"
+openapi-spec-validator = ">=0.2.8,<=0.5.2"
 jinja2 = ">=2.10.1,<4.0"
 inflect = ">=4.1.0,<6.0"
 black = ">=19.10b0"
@@ -64,7 +64,7 @@ pytest = ">6.0"
 pytest-benchmark = "*"
 pytest-cov = ">=2.12.1"
 pytest-mock = "*"
-mypy = "~1.0.1"
+mypy = ">=1.0.1,<1.4.0"
 black = "^23.3.0"
 freezegun = "*"
 types-Jinja2 = "*"
@@ -83,11 +83,9 @@ line-length = 88
 extend-select = ['Q', 'RUF100', 'C4', 'UP', 'I']
 flake8-quotes = {inline-quotes = 'single', multiline-quotes = 'double'}
 target-version = 'py37'
-ignore = ['E501']
+ignore = ['E501', 'UP006', 'UP007']
 extend-exclude = ['tests/data']
 
-[tool.ruff.pyupgrade]
-keep-runtime-typing = true
 
 [tool.black]
 line-length = 88

datamodel_code_generator-0.19.0/datamodel_code_generator/model/improts.py

@@ -1,4 +0,0 @@
-from datamodel_code_generator.imports import Import
-
-IMPORT_DATACLASS = Import.from_full_path('dataclasses.dataclass')
-IMPORT_FIELD = Import.from_full_path('dataclasses.field')

datamodel_code_generator-0.19.0/datamodel_code_generator/version.py

@@ -1 +0,0 @@
-version: str = '0.19.0'