Added custom extra fields to backend

No integration tests yet, TBD

spoolman/database/filament.py

@@ -41,6 +41,7 @@ async def create(
     settings_extruder_temp: Optional[int] = None,
     settings_bed_temp: Optional[int] = None,
     color_hex: Optional[str] = None,
+    extra: Optional[dict[str, str]] = None,
 ) -> models.Filament:
     """Add a new filament to the database."""
     vendor_item: Optional[models.Vendor] = None
@@ -62,6 +63,7 @@ async def create(
         settings_extruder_temp=settings_extruder_temp,
         settings_bed_temp=settings_bed_temp,
         color_hex=color_hex,
+        extra=[models.FilamentField(key=k, value=v) for k, v in (extra or {}).items()],
     )
     db.add(filament)
     await db.commit()
@@ -131,7 +133,7 @@ async def find(
                 stmt = stmt.order_by(field.desc())
 
     rows = await db.execute(stmt)
-    result = list(rows.scalars().all())
+    result = list(rows.unique().scalars().all())
     if total_count is None:
         total_count = len(result)
 
@@ -152,6 +154,8 @@ async def update(
                 filament.vendor = None
             else:
                 filament.vendor = await vendor.get_by_id(db, v)
+        elif k == "extra":
+            filament.extra = [models.FilamentField(key=k, value=v) for k, v in v.items()]
         else:
             setattr(filament, k, v)
     await db.commit()

spoolman/database/models.py

@@ -4,10 +4,11 @@ from datetime import datetime
 from typing import Optional
 
 from sqlalchemy import ForeignKey, Integer, String, Text
+from sqlalchemy.ext.asyncio import AsyncAttrs
 from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship
 
 
-class Base(DeclarativeBase):
+class Base(AsyncAttrs, DeclarativeBase):
     pass
 
 
@@ -19,6 +20,11 @@ class Vendor(Base):
     name: Mapped[str] = mapped_column(String(64))
     comment: Mapped[Optional[str]] = mapped_column(String(1024))
     filaments: Mapped[list["Filament"]] = relationship(back_populates="vendor")
+    extra: Mapped[list["VendorField"]] = relationship(
+        back_populates="vendor",
+        cascade="save-update, merge, delete, delete-orphan",
+        lazy="joined",
+    )
 
 
 class Filament(Base):
@@ -41,6 +47,11 @@ class Filament(Base):
     settings_extruder_temp: Mapped[Optional[int]] = mapped_column(comment="Overridden extruder temperature.")
     settings_bed_temp: Mapped[Optional[int]] = mapped_column(comment="Overridden bed temperature.")
     color_hex: Mapped[Optional[str]] = mapped_column(String(8))
+    extra: Mapped[list["FilamentField"]] = relationship(
+        back_populates="filament",
+        cascade="save-update, merge, delete, delete-orphan",
+        lazy="joined",
+    )
 
 
 class Spool(Base):
@@ -58,6 +69,11 @@ class Spool(Base):
     lot_nr: Mapped[Optional[str]] = mapped_column(String(64))
     comment: Mapped[Optional[str]] = mapped_column(String(1024))
     archived: Mapped[Optional[bool]] = mapped_column()
+    extra: Mapped[list["SpoolField"]] = relationship(
+        back_populates="spool",
+        cascade="save-update, merge, delete, delete-orphan",
+        lazy="joined",
+    )
 
 
 class Setting(Base):
@@ -66,3 +82,30 @@ class Setting(Base):
     key: Mapped[str] = mapped_column(String(64), primary_key=True, index=True)
     value: Mapped[str] = mapped_column(Text())
     last_updated: Mapped[datetime] = mapped_column()
+
+
+class VendorField(Base):
+    __tablename__ = "vendor_field"
+
+    vendor_id: Mapped[int] = mapped_column(ForeignKey("vendor.id"), primary_key=True, index=True)
+    vendor: Mapped["Vendor"] = relationship(back_populates="extra")
+    key: Mapped[str] = mapped_column(String(64), primary_key=True, index=True)
+    value: Mapped[str] = mapped_column(Text())
+
+
+class FilamentField(Base):
+    __tablename__ = "filament_field"
+
+    filament_id: Mapped[int] = mapped_column(ForeignKey("filament.id"), primary_key=True, index=True)
+    filament: Mapped["Filament"] = relationship(back_populates="extra")
+    key: Mapped[str] = mapped_column(String(64), primary_key=True, index=True)
+    value: Mapped[str] = mapped_column(Text())
+
+
+class SpoolField(Base):
+    __tablename__ = "spool_field"
+
+    spool_id: Mapped[int] = mapped_column(ForeignKey("spool.id"), primary_key=True, index=True)
+    spool: Mapped["Spool"] = relationship(back_populates="extra")
+    key: Mapped[str] = mapped_column(String(64), primary_key=True, index=True)
+    value: Mapped[str] = mapped_column(Text())

spoolman/database/spool.py

@@ -43,6 +43,7 @@ async def create(
     lot_nr: Optional[str] = None,
     comment: Optional[str] = None,
     archived: bool = False,
+    extra: Optional[dict[str, str]] = None,
 ) -> models.Spool:
     """Add a new spool to the database. Leave weight empty to assume full spool."""
     filament_item = await filament.get_by_id(db, filament_id)
@@ -71,6 +72,7 @@ async def create(
         lot_nr=lot_nr,
         comment=comment,
         archived=archived,
+        extra=[models.SpoolField(key=k, value=v) for k, v in (extra or {}).items()],
     )
     db.add(spool)
     await db.commit()
@@ -158,7 +160,7 @@ async def find(
                 stmt = stmt.order_by(field.desc())
 
     rows = await db.execute(stmt)
-    result = list(rows.scalars().all())
+    result = list(rows.unique().scalars().all())
     if total_count is None:
         total_count = len(result)
 
@@ -182,6 +184,8 @@ async def update(
             spool.used_weight = max(spool.filament.weight - v, 0)
         elif isinstance(v, datetime):
             setattr(spool, k, utc_timezone_naive(v))
+        elif k == "extra":
+            spool.extra = [models.SpoolField(key=k, value=v) for k, v in v.items()]
         else:
             setattr(spool, k, v)
     await db.commit()

spoolman/database/vendor.py

@@ -18,12 +18,14 @@ async def create(
     db: AsyncSession,
     name: Optional[str] = None,
     comment: Optional[str] = None,
+    extra: Optional[dict[str, str]] = None,
 ) -> models.Vendor:
     """Add a new vendor to the database."""
     vendor = models.Vendor(
         name=name,
         registered=datetime.utcnow().replace(microsecond=0),
         comment=comment,
+        extra=[models.VendorField(key=k, value=v) for k, v in (extra or {}).items()],
     )
     db.add(vendor)
     await db.commit()
@@ -72,7 +74,7 @@ async def find(
                 stmt = stmt.order_by(field.desc())
 
     rows = await db.execute(stmt)
-    result = list(rows.scalars().all())
+    result = list(rows.unique().scalars().all())
     if total_count is None:
         total_count = len(result)
 
@@ -88,7 +90,10 @@ async def update(
     """Update the fields of a vendor object."""
     vendor = await get_by_id(db, vendor_id)
     for k, v in data.items():
-        setattr(vendor, k, v)
+        if k == "extra":
+            vendor.extra = [models.VendorField(key=k, value=v) for k, v in v.items()]
+        else:
+            setattr(vendor, k, v)
     await db.commit()
     await vendor_changed(vendor, EventType.UPDATED)
     return vendor