add: Ability to set default and additional kwargs on ModelField (#16)

Author: mslaursen

Makefile

@@ -12,4 +12,7 @@ lint:
 	uv run ruff check . --fix --unsafe-fixes
 
 test:
-	uv run pytest tests -s -v
+	uv run pytest tests -s -v
+
+test-filter:
+	uv run pytest tests -v -s -k $(filter)

fastapi_forge/dtos.py

@@ -1,4 +1,4 @@
-from typing import Annotated, Self
+from typing import Annotated, Any, Self
 
 from pydantic import (
     BaseModel,
@@ -44,6 +44,10 @@ class ModelField(_Base):
     nullable: bool = False
     unique: bool = False
     index: bool = False
+
+    default_value: str | None = None
+    extra_kwargs: dict[str, Any] | None = None
+
     metadata: ModelFieldMetadata = ModelFieldMetadata()
 
     @computed_field
@@ -74,6 +78,14 @@ def _validate(self) -> Self:
         if metadata.is_foreign_key and self.type != FieldDataType.UUID:
             msg = "Foreign Keys must be of type UUID."
             raise ValueError(msg)
+
+        if self.extra_kwargs and any(
+            k == "default" for k, _ in self.extra_kwargs.items()
+        ):
+            msg = "The 'default' argument should be set through the default attr."
+            raise ValueError(
+                msg,
+            )
         return self
 
     @computed_field
@@ -199,6 +211,16 @@ def _validate(self) -> Self:
                 f"Model '{self.name}' contains duplicate relationship field names.",
             )
 
+        if sum(field.metadata.is_created_at_timestamp for field in self.fields) > 1:
+            raise ValueError(
+                f"Model '{self.name}' has more than one 'created_at_timestamp' fields."
+            )
+
+        if sum(field.metadata.is_updated_at_timestamp for field in self.fields) > 1:
+            raise ValueError(
+                f"Model '{self.name}' has more than one 'updated_at_timestamp' fields."
+            )
+
         return self
 
     @model_validator(mode="after")

fastapi_forge/example-projects/game_zone.yaml

@@ -20,10 +20,14 @@ project:
           type: String
         - name: created_at
           type: DateTime
+          default_value: datetime.now(timezone.utc)
           metadata:
             is_created_at_timestamp: true
         - name: updated_at
           type: DateTime
+          default_value: datetime.now(timezone.utc)
+          extra_kwargs:
+            onupdate: datetime.now(timezone.utc)
           metadata:
             is_updated_at_timestamp: true
       relationships: []
@@ -45,10 +49,14 @@ project:
           nullable: true
         - name: created_at
           type: DateTime
+          default_value: datetime.now(timezone.utc)
           metadata:
             is_created_at_timestamp: true
         - name: updated_at
           type: DateTime
+          default_value: datetime.now(timezone.utc)
+          extra_kwargs:
+            onupdate: datetime.now(timezone.utc)
           metadata:
             is_updated_at_timestamp: true
       relationships:
@@ -75,10 +83,14 @@ project:
           nullable: true
         - name: created_at
           type: DateTime
+          default_value: datetime.now(timezone.utc)
           metadata:
             is_created_at_timestamp: true
         - name: updated_at
           type: DateTime
+          default_value: datetime.now(timezone.utc)
+          extra_kwargs:
+            onupdate: datetime.now(timezone.utc)
           metadata:
             is_updated_at_timestamp: true
       relationships: []
@@ -90,19 +102,21 @@ project:
           primary_key: true
         - name: purchase_date
           type: DateTime
-          metadata:
-            is_created_at_timestamp: true
         - name: playtime_hours
           type: Integer
         - name: achievements_unlocked
           type: Integer
           default: 0
         - name: created_at
           type: DateTime
+          default_value: datetime.now(timezone.utc)
           metadata:
             is_created_at_timestamp: true
         - name: updated_at
           type: DateTime
+          default_value: datetime.now(timezone.utc)
+          extra_kwargs:
+            onupdate: datetime.now(timezone.utc)
           metadata:
             is_updated_at_timestamp: true
       relationships:
@@ -126,10 +140,14 @@ project:
           type: Integer
         - name: created_at
           type: DateTime
+          default_value: datetime.now(timezone.utc)
           metadata:
             is_created_at_timestamp: true
         - name: updated_at
           type: DateTime
+          default_value: datetime.now(timezone.utc)
+          extra_kwargs:
+            onupdate: datetime.now(timezone.utc)
           metadata:
             is_updated_at_timestamp: true
       relationships:
@@ -154,10 +172,14 @@ project:
           nullable: true
         - name: created_at
           type: DateTime
+          default_value: datetime.now(timezone.utc)
           metadata:
             is_created_at_timestamp: true
         - name: updated_at
           type: DateTime
+          default_value: datetime.now(timezone.utc)
+          extra_kwargs:
+            onupdate: datetime.now(timezone.utc)
           metadata:
             is_updated_at_timestamp: true
       relationships: