feat: support AwareDatetime for timezone supported apis

Author: tractorcow

docs/references/index.md

@@ -28,6 +28,12 @@ Options:
                          faster processing and better type support.
                          Defaults to False.
 
+--use-awaredatetime      Use timezone-aware datetime objects instead of naive
+                         datetime objects. This ensures proper handling of
+                         timezone information in the generated models.
+                         Only supported with Pydantic v2.
+                         Defaults to False.
+
 --custom-template-path TEXT
                          Custom template path to use. Allows overriding of the
                          built in templates.

src/openapi_python_generator/__main__.py

@@ -31,6 +31,14 @@
     help="Use the orjson library to serialize the data. This is faster than the default json library and provides "
     "serialization of datetimes and other types that are not supported by the default json library.",
 )
+@click.option(
+    "--use-awaredatetime",
+    is_flag=True,
+    show_default=True,
+    default=False,
+    help="Use timezone-aware datetime objects instead of naive datetime objects. This ensures proper handling of "
+    "timezone information in the generated models.",
+)
 @click.option(
     "--custom-template-path",
     type=str,
@@ -58,6 +66,7 @@ def main(
     library: Optional[HTTPLibrary] = HTTPLibrary.httpx,
     env_token_name: Optional[str] = None,
     use_orjson: bool = False,
+    use_awaredatetime: bool = False,
     custom_template_path: Optional[str] = None,
     pydantic_version: PydanticVersion = PydanticVersion.V2,
     formatter: Formatter = Formatter.BLACK,
@@ -69,7 +78,7 @@ def main(
     an OUTPUT path, where the resulting client is created.
     """
     generate_data(
-        source, output, library, env_token_name, use_orjson, custom_template_path, pydantic_version, formatter
+        source, output, library, env_token_name, use_orjson, use_awaredatetime, custom_template_path, pydantic_version, formatter
     )
 
 

src/openapi_python_generator/generate_data.py

@@ -180,6 +180,7 @@ def generate_data(
     library: Optional[HTTPLibrary] = HTTPLibrary.httpx,
     env_token_name: Optional[str] = None,
     use_orjson: bool = False,
+    use_awaredatetime: bool = False,
     custom_template_path: Optional[str] = None,
     pydantic_version: PydanticVersion = PydanticVersion.V2,
     formatter: Formatter = Formatter.BLACK,
@@ -195,6 +196,7 @@ def generate_data(
         library_config_dict[library],
         env_token_name,
         use_orjson,
+        use_awaredatetime,
         custom_template_path,
         pydantic_version,
     )

src/openapi_python_generator/language_converters/python/common.py

@@ -7,6 +7,7 @@
 _use_orjson: bool = False
 _pydantic_version: PydanticVersion = PydanticVersion.V2
 _custom_template_path: str = None
+_pydantic_use_awaredatetime: bool = False
 _symbol_ascii_strip_re = re.compile(r"[^A-Za-z0-9_]")
 
 
@@ -60,6 +61,23 @@ def get_custom_template_path() -> Optional[str]:
     return _custom_template_path
 
 
+def set_pydantic_use_awaredatetime(value: bool) -> None:
+    """
+    Set whether to use AwareDateTime from pydantic instead of datetime.
+    :param value: value of the variable
+    """
+    global _pydantic_use_awaredatetime
+    _pydantic_use_awaredatetime = value
+
+def get_pydantic_use_awaredatetime() -> bool:
+    """
+    Get whether to use AwareDateTime from pydantic instead of datetime.
+    :return: value of the variable
+    """
+    global _pydantic_use_awaredatetime
+    return _pydantic_use_awaredatetime
+
+
 def normalize_symbol(symbol: str) -> str:
     """
     Remove invalid characters & keywords in Python symbol names

src/openapi_python_generator/language_converters/python/generator.py

@@ -22,16 +22,20 @@ def generator(
     library_config: LibraryConfig,
     env_token_name: Optional[str] = None,
     use_orjson: bool = False,
+    use_awaredatetime: bool = False,
     custom_template_path: Optional[str] = None,
     pydantic_version: PydanticVersion = PydanticVersion.V2,
 ) -> ConversionResult:
     """
     Generate Python code from an OpenAPI 3.0 specification.
     """
+    if use_awaredatetime and pydantic_version != PydanticVersion.V2:
+        raise ValueError("Timezone-aware datetime is only supported with Pydantic v2. Please use --pydantic-version v2.")
 
     common.set_use_orjson(use_orjson)
     common.set_custom_template_path(custom_template_path)
     common.set_pydantic_version(pydantic_version)
+    common.set_pydantic_use_awaredatetime(use_awaredatetime)
 
     if data.components is not None:
         models = generate_models(data.components, pydantic_version)

src/openapi_python_generator/language_converters/python/model_generator.py

@@ -141,8 +141,12 @@ def type_converter(  # noqa: C901
         # orjson and pydantic v2 both support datetime
         and (common.get_use_orjson() or common.get_pydantic_version() == PydanticVersion.V2)
     ):
-        converted_type = pre_type + "datetime" + post_type
-        import_types = ["from datetime import datetime"]
+        if common.get_pydantic_use_awaredatetime():
+            converted_type = pre_type + "AwareDatetime" + post_type
+            import_types = ["from pydantic import AwareDatetime"]
+        else:
+            converted_type = pre_type + "datetime" + post_type
+            import_types = ["from datetime import datetime"]
     elif (
         schema.type == "string"
         and schema.schema_format == "date"