Generate Python model with required fields also

Author: mmwinther

.github/workflows/generate-python.yml

@@ -35,35 +35,26 @@ jobs:
           git config user.name "dapla-bot[bot]"
           git config user.email "143391972+dapla-bot[bot]@users.noreply.github.com"
 
-      - uses: actions/setup-python@v2
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
         with:
-          python-version: 3.11.5
+          enable-cache: true
 
-      - name: Install pipx
-        run: |
-          python -m pip install --upgrade pipx
-          python -m pipx ensurepath
-
-      - name: Install datamodel-codegen
-        run: |
-          python -m pipx install datamodel-code-generator==0.25.2
+      - name: Generate All-optional Python models
+        run: >
+          uvx
+            --with datamodel-code-generator
+            -- bash bin/generate_python.sh
+                      --output=generated/python/datadoc_model/datadoc_model/all_optional/model.py
+                      --force-optional
 
-      - name: Generate Python
+      - name: Generate Required Python models
         run: >
-          datamodel-codegen
-          --input-file-type jsonschema
-          --input src/metadata-container-json-schema.json
-          --output-model-type pydantic_v2.BaseModel
-          --base-class "datadoc_model.datadoc_base_model.DatadocBaseModel"
-          --use-default
-          --use-title-as-name
-          --use-one-literal-as-default
-          --force-optional
-          --use-subclass-enum
-          --use-standard-collections
-          --use-double-quotes
-          --target-python-version 3.10
-          --output generated/python/datadoc_model/datadoc_model/model.py
+          uvx
+            --with datamodel-code-generator
+            -- bash bin/generate_python.sh
+                      --output=generated/python/datadoc_model/datadoc_model/required/model.py
+                      --force-optional
 
       - name: Check for modified files
         id: git-check

bin/generate_python.sh

@@ -0,0 +1,29 @@
+#! /usr/bin/env bash
+
+while [ "$#" -gt 0 ]; do
+  case "$1" in
+    --output=*) OUTPUT="${1#*=}"; shift 1;;
+    --output) echo "$1 requires an argument" >&2; exit 1;;
+
+    --force-optional) FORCE_OPTIONAL=true; shift 1;;
+
+    -*) echo "$LOG_PREFIX unknown option: $1" >&2; exit 1;;
+    # Skip positional arguments
+    *) shift 1;;
+  esac
+done
+
+datamodel-codegen \
+    --input-file-type jsonschema \
+    --input src/metadata-container-json-schema.json \
+    --output-model-type pydantic_v2.BaseModel \
+    --base-class "datadoc_model.datadoc_base_model.DatadocBaseModel" \
+    --use-default \
+    --use-title-as-name \
+    --use-one-literal-as-default \
+    --use-subclass-enum \
+    --use-standard-collections \
+    --use-double-quotes \
+    --target-python-version 3.10 \
+    --output "$OUTPUT" \
+    ${FORCE_OPTIONAL:+"--force-optional"}

generated/python/datadoc_model/datadoc_model/__init__.py

@@ -0,0 +1,4 @@
+# This is provided for backwards compatibility
+import all_optional.model
+import all_optional.model as model
+import required.model

generated/python/datadoc_model/datadoc_model/all_optional/__init__.py

@@ -1,17 +1,16 @@
 # generated by datamodel-codegen:
 #   filename:  metadata-container-json-schema.json
-#   timestamp: 2024-07-08T12:55:43+00:00
+#   timestamp: 2025-05-02T12:33:40+00:00
 
 from __future__ import annotations
 
-from datetime import date
+from datetime import date, datetime
 from enum import Enum
 from typing import Any, Literal, Optional, Union
 from uuid import UUID
 
-from pydantic import AnyUrl, AwareDatetime, Field, RootModel
-
 from datadoc_model.datadoc_base_model import DatadocBaseModel
+from pydantic import AnyUrl, Field, RootModel
 
 
 class Assessment(str, Enum):
@@ -118,7 +117,7 @@ class TemporalityTypeType(str, Enum):
 
 
 class PseudoDataset(DatadocBaseModel):
-    dataset_pseudo_time: Optional[AwareDatetime] = Field(
+    dataset_pseudo_time: Optional[datetime] = Field(
         None,
         description="Time at which the dataset was pseudonymized. In ISO 8601 format.",
         title="Dataset pseudo time",
@@ -268,7 +267,7 @@ class Dataset(DatadocBaseModel):
     use_restriction: Optional[UseRestriction] = Field(
         None, description="Data set use restriction", title="Use restriction"
     )
-    use_restriction_date: Optional[AwareDatetime] = Field(
+    use_restriction_date: Optional[datetime] = Field(
         None,
         description="Use restriction date, eg. the date (deadline) for when data must be deleted/anonymised.",
         title="Use restriction date",
@@ -291,15 +290,15 @@ class Dataset(DatadocBaseModel):
         description="The file path contains the data set's name and the path to where it is stored",
         title="File path",
     )
-    metadata_created_date: Optional[AwareDatetime] = Field(
+    metadata_created_date: Optional[datetime] = Field(
         None,
         description="Created date for metadata about the data set",
         title="Metadata created date",
     )
     metadata_created_by: Optional[str] = Field(
         None, description="Created by identifiable person.", title="Metadata created by"
     )
-    metadata_last_updated_date: Optional[AwareDatetime] = Field(
+    metadata_last_updated_date: Optional[datetime] = Field(
         None,
         description="Last updated date for metadata about the dataset",
         title="Metadata last updated date",
@@ -326,10 +325,10 @@ class OtherSpecialValue(DatadocBaseModel):
     name: Optional[LanguageStringType] = Field(
         None, description="Other value name (text)", title="Name"
     )
-    valid_from: Optional[AwareDatetime] = Field(
+    valid_from: Optional[datetime] = Field(
         None, description="Other value valid from date", title="Valid from"
     )
-    valid_until: Optional[AwareDatetime] = Field(
+    valid_until: Optional[datetime] = Field(
         None, description="Other value until date", title="Valid until"
     )