Use format: date-time instead of pattern (.yml) and AwareDatetime (.py) for datetime strings (#7)

* Use `format: date-time` (.yml) and `AwareDatetime` (.py) for datetime strings

* Update README.md

---------

Co-authored-by: Konstantin <[email protected]>

Author: hf-kklein

README.md

@@ -47,6 +47,8 @@ Most of the classes are autogenerated from the [`openapi.yml`](openapi/openapi.y
 Note that we fixed some errors in the official OpenAPI spec.
 Our changes are mentioned at the beginning of the [`openapi.yml`](openapi/openapi.yml) file.
 
+https://github.com/Hochfrequenz/malo-ident-python-models/blob/fe41321c74773336984a3517adc79b3ac4f43349/openapi/openapi.yml#L4-L8
+
 After updating the `openapi.yml` file, use
 
 ```bash

openapi/openapi.yml

@@ -5,6 +5,7 @@
 #    a) It's missing the 'measured' valued which is given as example but not part of the enum members.
 #    b) there is a typo: 'nonActice' should be 'nonActive'
 # 2. Some yaml parsers fail, because: Multi-line double-quoted strings are not sufficiently indented (can be found with prettier in CI)
+# 3. Datetimes are poorly designed. Instead of using the OpenAPI format:date-time, a regex with good intentions is used. This leads to code-generators using type string instead of datetime.
 
 openapi: 3.0.0
 servers:
@@ -230,7 +231,8 @@ components:
       example: V567345345
 
     creationDateTime:
-      pattern: "20(\\d{2}(\\-(0[13578]|1[02])\\-(0[1-9]|[12]\\d|3[01])|\\-02\\-(0[1-9]|1\\d|2[0-8])|\\-(0[469]|11)\\-(0[1-9]|[12]\\d|30))|([02468][048]|[13579][26])\\-02\\-(29))T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(\\.[\\d]{1,4})?Z"
+      # pattern: "20(\\d{2}(\\-(0[13578]|1[02])\\-(0[1-9]|[12]\\d|3[01])|\\-02\\-(0[1-9]|1\\d|2[0-8])|\\-(0[469]|11)\\-(0[1-9]|[12]\\d|30))|([02468][048]|[13579][26])\\-02\\-(29))T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(\\.[\\d]{1,4})?Z"
+      format: date-time # ERROR-3
       type: string
       description: Zeitpunkt an dem der Aufruf erstellt wurde
       example: 2023-08-01T12:30:00.1704Z
@@ -409,12 +411,14 @@ components:
         - consumption
         - production
     executionTimeFrom:
-      pattern: "20(\\d{2}(\\-(0[13578]|1[02])\\-(0[1-9]|[12]\\d|3[01])|\\-02\\-(0[1-9]|1\\d|2[0-8])|\\-(0[469]|11)\\-(0[1-9]|[12]\\d|30))|([02468][048]|[13579][26])\\-02\\-(29))T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ"
+      # pattern: "20(\\d{2}(\\-(0[13578]|1[02])\\-(0[1-9]|[12]\\d|3[01])|\\-02\\-(0[1-9]|1\\d|2[0-8])|\\-(0[469]|11)\\-(0[1-9]|[12]\\d|30))|([02468][048]|[13579][26])\\-02\\-(29))T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ"
+      format: date-time # ERROR-3
       type: string
       description: Beginnzeitpunkt, Zeitpunkt zu dem die zugeordneten Marktpartner oder Lokationen zugeordnet werden. Dieser Zeitpunkt muss ein Tagesbeginn 00:00 Uhr gesetzlicher deutscher Zeit sein.
       example: 2023-08-01T22:00:00Z
     executionTimeUntil:
-      pattern: "20(\\d{2}(\\-(0[13578]|1[02])\\-(0[1-9]|[12]\\d|3[01])|\\-02\\-(0[1-9]|1\\d|2[0-8])|\\-(0[469]|11)\\-(0[1-9]|[12]\\d|30))|([02468][048]|[13579][26])\\-02\\-(29))T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ"
+      # pattern: "20(\\d{2}(\\-(0[13578]|1[02])\\-(0[1-9]|[12]\\d|3[01])|\\-02\\-(0[1-9]|1\\d|2[0-8])|\\-(0[469]|11)\\-(0[1-9]|[12]\\d|30))|([02468][048]|[13579][26])\\-02\\-(29))T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ"
+      format: date-time # ERROR-3
       type: string
       description: Endezeitpunkt, Zeitpunkt bis zu dem die zugeordneten Marktpartner oder Lokationen zugeordnet werden. Dieser Zeitpunkt muss ein Tagesbeginn 00:00 Uhr gesetzlicher deutscher Zeit sein.
       example: 2023-08-01T22:00:00Z
@@ -454,7 +458,8 @@ components:
       description: Angabe der Hausnummernergänzung der Marktlokationsadresse
       example: F
     identificationDateTime:
-      pattern: "20(\\d{2}(\\-(0[13578]|1[02])\\-(0[1-9]|[12]\\d|3[01])|\\-02\\-(0[1-9]|1\\d|2[0-8])|\\-(0[469]|11)\\-(0[1-9]|[12]\\d|30))|([02468][048]|[13579][26])\\-02\\-(29))T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ"
+      # pattern: "20(\\d{2}(\\-(0[13578]|1[02])\\-(0[1-9]|[12]\\d|3[01])|\\-02\\-(0[1-9]|1\\d|2[0-8])|\\-(0[469]|11)\\-(0[1-9]|[12]\\d|30))|([02468][048]|[13579][26])\\-02\\-(29))T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\dZ"
+      format: date-time
       type: string
       description: Zeitpunkt zu dem die Identifikation stattfinden soll. Dieser Zeitpunkt muss ein Tagesbeginn 00:00 Uhr gesetzlicher deutscher Zeit sein.
       example: 2023-08-02T22:00:00Z
@@ -573,10 +578,10 @@ components:
     marketLocationProperty:
       type: string
       description: Eigenschaft der Marktlokation. nonActive=ruhende Marktlokation, customerFacility=Marktlokation ist eine Kundenanlage, standard=alle "Standard" Marktlokationen die nicht unter die Eigenschaft "ruhende Marktlokation" und "Kundenanlage" fallen.
-      example: measured # this is probably a copy-paste error
+      example: measured # ERROR-1a) this is probably a copy-paste error
       enum:
         - customerFacility
-        - nonActive # was 'nonActice' before
+        - nonActive # ERROR-1b) was 'nonActice' before
         - standard
 
     marketLocationSupplier:

src/maloident/_autogenerated.py

@@ -1,13 +1,13 @@
 # generated by datamodel-codegen:
 #   filename:  openapi.yml
-#   timestamp: 2024-09-25T17:15:02+00:00
+#   timestamp: 2024-10-02T11:39:11+00:00
 
 from __future__ import annotations
 
 from enum import Enum
 from typing import List, Optional
 
-from pydantic import BaseModel, Field, RootModel, constr
+from pydantic import AwareDatetime, BaseModel, Field, RootModel, constr
 
 
 class City(RootModel[str]):
@@ -32,16 +32,10 @@ class CustomerNumber(RootModel[str]):
     )
 
 
-class CreationDateTime(
-    RootModel[
-        constr(
-            pattern=r"20(\d{2}(\-(0[13578]|1[02])\-(0[1-9]|[12]\d|3[01])|\-02\-(0[1-9]|1\d|2[0-8])|\-(0[469]|11)\-(0[1-9]|[12]\d|30))|([02468][048]|[13579][26])\-02\-(29))T([01]\d|2[0-3]):[0-5]\d:[0-5]\d(\.[\d]{1,4})?Z"
-        )
-    ]
-):
-    root: constr(
-        pattern=r"20(\d{2}(\-(0[13578]|1[02])\-(0[1-9]|[12]\d|3[01])|\-02\-(0[1-9]|1\d|2[0-8])|\-(0[469]|11)\-(0[1-9]|[12]\d|30))|([02468][048]|[13579][26])\-02\-(29))T([01]\d|2[0-3]):[0-5]\d:[0-5]\d(\.[\d]{1,4})?Z"
-    ) = Field(..., description="Zeitpunkt an dem der Aufruf erstellt wurde", examples=["2023-08-01T12:30:00.1704Z"])
+class CreationDateTime(RootModel[AwareDatetime]):
+    root: AwareDatetime = Field(
+        ..., description="Zeitpunkt an dem der Aufruf erstellt wurde", examples=["2023-08-01T12:30:00.1704Z"]
+    )
 
 
 class DistrictName(RootModel[str]):
@@ -66,32 +60,16 @@ class EnergyDirection(Enum):
     production = "production"
 
 
-class ExecutionTimeFrom(
-    RootModel[
-        constr(
-            pattern=r"20(\d{2}(\-(0[13578]|1[02])\-(0[1-9]|[12]\d|3[01])|\-02\-(0[1-9]|1\d|2[0-8])|\-(0[469]|11)\-(0[1-9]|[12]\d|30))|([02468][048]|[13579][26])\-02\-(29))T([01]\d|2[0-3]):[0-5]\d:[0-5]\dZ"
-        )
-    ]
-):
-    root: constr(
-        pattern=r"20(\d{2}(\-(0[13578]|1[02])\-(0[1-9]|[12]\d|3[01])|\-02\-(0[1-9]|1\d|2[0-8])|\-(0[469]|11)\-(0[1-9]|[12]\d|30))|([02468][048]|[13579][26])\-02\-(29))T([01]\d|2[0-3]):[0-5]\d:[0-5]\dZ"
-    ) = Field(
+class ExecutionTimeFrom(RootModel[AwareDatetime]):
+    root: AwareDatetime = Field(
         ...,
         description="Beginnzeitpunkt, Zeitpunkt zu dem die zugeordneten Marktpartner oder Lokationen zugeordnet werden. Dieser Zeitpunkt muss ein Tagesbeginn 00:00 Uhr gesetzlicher deutscher Zeit sein.",
         examples=["2023-08-01T22:00:00Z"],
     )
 
 
-class ExecutionTimeUntil(
-    RootModel[
-        constr(
-            pattern=r"20(\d{2}(\-(0[13578]|1[02])\-(0[1-9]|[12]\d|3[01])|\-02\-(0[1-9]|1\d|2[0-8])|\-(0[469]|11)\-(0[1-9]|[12]\d|30))|([02468][048]|[13579][26])\-02\-(29))T([01]\d|2[0-3]):[0-5]\d:[0-5]\dZ"
-        )
-    ]
-):
-    root: constr(
-        pattern=r"20(\d{2}(\-(0[13578]|1[02])\-(0[1-9]|[12]\d|3[01])|\-02\-(0[1-9]|1\d|2[0-8])|\-(0[469]|11)\-(0[1-9]|[12]\d|30))|([02468][048]|[13579][26])\-02\-(29))T([01]\d|2[0-3]):[0-5]\d:[0-5]\dZ"
-    ) = Field(
+class ExecutionTimeUntil(RootModel[AwareDatetime]):
+    root: AwareDatetime = Field(
         ...,
         description="Endezeitpunkt, Zeitpunkt bis zu dem die zugeordneten Marktpartner oder Lokationen zugeordnet werden. Dieser Zeitpunkt muss ein Tagesbeginn 00:00 Uhr gesetzlicher deutscher Zeit sein.",
         examples=["2023-08-01T22:00:00Z"],
@@ -118,16 +96,8 @@ class HouseNumberAddition(RootModel[str]):
     root: str = Field(..., description="Angabe der Hausnummernergänzung der Marktlokationsadresse", examples=["F"])
 
 
-class IdentificationDateTime(
-    RootModel[
-        constr(
-            pattern=r"20(\d{2}(\-(0[13578]|1[02])\-(0[1-9]|[12]\d|3[01])|\-02\-(0[1-9]|1\d|2[0-8])|\-(0[469]|11)\-(0[1-9]|[12]\d|30))|([02468][048]|[13579][26])\-02\-(29))T([01]\d|2[0-3]):[0-5]\d:[0-5]\dZ"
-        )
-    ]
-):
-    root: constr(
-        pattern=r"20(\d{2}(\-(0[13578]|1[02])\-(0[1-9]|[12]\d|3[01])|\-02\-(0[1-9]|1\d|2[0-8])|\-(0[469]|11)\-(0[1-9]|[12]\d|30))|([02468][048]|[13579][26])\-02\-(29))T([01]\d|2[0-3]):[0-5]\d:[0-5]\dZ"
-    ) = Field(
+class IdentificationDateTime(RootModel[AwareDatetime]):
+    root: AwareDatetime = Field(
         ...,
         description="Zeitpunkt zu dem die Identifikation stattfinden soll. Dieser Zeitpunkt muss ein Tagesbeginn 00:00 Uhr gesetzlicher deutscher Zeit sein.",
         examples=["2023-08-02T22:00:00Z"],