Renamed to Spoolman

Spoolson just didn't sound that good after all
2023-04-02 19:19:15 +02:00
parent c31c3dea42
commit 6fd9662c42
19 changed files with 24 additions and 24 deletions
--- a/spoolman/api/v1/models.py
+++ b/spoolman/api/v1/models.py
@@ -0,0 +1,91 @@
+"""Pydantic data models for typing the FastAPI request/responses."""
+
+from datetime import datetime
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+from spoolman.database import models
+
+
+class Message(BaseModel):
+    message: str = Field()
+
+
+class Vendor(BaseModel):
+    id: int = Field(description="Unique internal ID of this vendor.")
+    name: str = Field(max_length=64, description="Vendor name.")
+    comment: Optional[str] = Field(max_length=1024, description="Free text comment about this vendor.")
+
+    @staticmethod
+    def from_db(item: models.Vendor) -> "Vendor":
+        """Create a new Pydantic vendor object from a database vendor object."""
+        return Vendor(
+            id=item.id,
+            name=item.name,
+            comment=item.comment,
+        )
+
+
+class Filament(BaseModel):
+    id: int = Field(description="Unique internal ID of this filament type.")
+    name: Optional[str] = Field(
+        max_length=64,
+        description=(
+            "Filament name, to distinguish this filament type among others from the same vendor."
+            "Should contain its color for example."
+        ),
+    )
+    vendor: Optional[Vendor] = Field(description="The vendor of this filament type.")
+    material: Optional[str] = Field(max_length=64, description="The material of this filament, e.g. PLA.")
+    price: Optional[float] = Field(ge=0, description="The price of this filament in the system configured currency.")
+    density: float = Field(gt=0, description="The density of this filament in g/cm3.")
+    diameter: float = Field(gt=0, description="The diameter of this filament in mm.")
+    weight: Optional[float] = Field(gt=0, description="The weight of the filament in a full spool.")
+    spool_weight: Optional[float] = Field(gt=0, description="The empty spool weight.")
+    article_number: Optional[str] = Field(max_length=64, description="Vendor article number, e.g. EAN, QR code, etc.")
+    comment: Optional[str] = Field(max_length=1024, description="Free text comment about this filament type.")
+
+    @staticmethod
+    def from_db(item: models.Filament) -> "Filament":
+        """Create a new Pydantic filament object from a database filament object."""
+        return Filament(
+            id=item.id,
+            name=item.name,
+            vendor=Vendor.from_db(item.vendor) if item.vendor is not None else None,
+            material=item.material,
+            price=item.price,
+            density=item.density,
+            diameter=item.diameter,
+            weight=item.weight,
+            spool_weight=item.spool_weight,
+            article_number=item.article_number,
+            comment=item.comment,
+        )
+
+
+class Spool(BaseModel):
+    id: int = Field(description="Unique internal ID of this spool of filament.")
+    registered: datetime = Field(description="When the spool was registered in the database.")
+    first_used: Optional[datetime] = Field(description="First logged occurence of spool usage.")
+    last_used: Optional[datetime] = Field(description="Last logged occurence of spool usage.")
+    filament: Filament = Field(description="The filament type of this spool.")
+    weight: float = Field(ge=0, description="Remaining weight of filament on the spool.")
+    location: Optional[str] = Field(max_length=64, description="Where this spool can be found.")
+    lot_nr: Optional[str] = Field(max_length=64, description="Vendor manufacturing lot/batch number of the spool.")
+    comment: Optional[str] = Field(max_length=1024, description="Free text comment about this specific spool.")
+
+    @staticmethod
+    def from_db(item: models.Spool) -> "Spool":
+        """Create a new Pydantic spool object from a database spool object."""
+        return Spool(
+            id=item.id,
+            registered=item.registered,
+            first_used=item.first_used,
+            last_used=item.last_used,
+            filament=Filament.from_db(item.filament),
+            weight=item.weight,
+            location=item.location,
+            lot_nr=item.lot_nr,
+            comment=item.comment,
+        )