Add date property type and improve handling of date-time properties

Author: Adam Gray

openapi_python_client/openapi_parser/openapi.py

@@ -4,7 +4,16 @@
 from enum import Enum
 from typing import Any, Dict, Generator, Iterable, List, Optional, Set, Union
 
-from .properties import EnumListProperty, EnumProperty, Property, ReferenceListProperty, RefProperty, property_from_dict
+from .properties import (
+    EnumListProperty,
+    EnumProperty,
+    Property,
+    ReferenceListProperty,
+    RefProperty,
+    property_from_dict,
+    DateTimeProperty,
+    DateProperty,
+)
 from .reference import Reference
 from .responses import ListRefResponse, RefResponse, Response, response_from_dict
 
@@ -113,6 +122,10 @@ def _add_parameters(self, data: Dict[str, Any]) -> None:
                 and prop.reference
             ):
                 self.relative_imports.add(import_string_from_reference(prop.reference, prefix="..models"))
+            if isinstance(prop, DateProperty):
+                self.relative_imports.add("from datetime import date")
+            if isinstance(prop, DateTimeProperty):
+                self.relative_imports.add("from datetime import datetime")
             if param_dict["in"] == ParameterLocation.QUERY:
                 self.query_parameters.append(prop)
             elif param_dict["in"] == ParameterLocation.PATH:

openapi_python_client/openapi_parser/properties.py

@@ -68,6 +68,20 @@ class DateTimeProperty(Property):
     _type_string: ClassVar[str] = "datetime"
     constructor_template: ClassVar[str] = "datetime_property.pyi"
 
+    def transform(self) -> str:
+        return f"{self.python_name()}.isoformat()"
+
+
+@dataclass
+class DateProperty(Property):
+    """ A property of type datetime.date """
+
+    _type_string: ClassVar[str] = "date"
+    constructor_template: ClassVar[str] = "date_property.pyi"
+
+    def transform(self) -> str:
+        return f"{self.python_name()}.isoformat()"
+
 
 @dataclass
 class FloatProperty(Property):
@@ -232,12 +246,14 @@ def property_from_dict(name: str, required: bool, data: Dict[str, Any]) -> Prope
     if "$ref" in data:
         return RefProperty(name=name, required=required, reference=Reference.from_ref(data["$ref"]), default=None)
     if data["type"] == "string":
-        if "format" not in data:
-            return StringProperty(
-                name=name, default=data.get("default"), required=required, pattern=data.get("pattern"),
-            )
-        elif data["format"] == "date-time":
-            return DateTimeProperty(name=name, required=required, default=data.get("default"))
+        if "format" in data:
+            if data.get("format") == "date-time":
+                return DateTimeProperty(name=name, required=required, default=data.get("default"))
+            elif data.get("format") == "date":
+                return DateProperty(name=name, required=required, default=data.get("default"))
+            else:
+                raise ValueError(f'Unsupported string format:{data["format"]}')
+        return StringProperty(name=name, default=data.get("default"), required=required, pattern=data.get("pattern"),)
     elif data["type"] == "number":
         return FloatProperty(name=name, default=data.get("default"), required=required)
     elif data["type"] == "integer":

openapi_python_client/templates/date_property.pyi

@@ -0,0 +1,7 @@
+{% if property.required %}
+        {{ property.name }} = date.fromisoformat(d["{{ property.name }}"])
+{% else %}
+        {{ property.name }} = None
+        if ({{ property.name }}_string := d.get("{{ property.name }}")) is not None:
+            {{ property.name }} = date.fromisoformat(cast(str, {{ property.name }}_string))
+{% endif %}