documentation and converted to username based exclusion of adding new kits

src/submissions/backend/db/models/kits.py

@@ -3,57 +3,88 @@ from sqlalchemy import Column, String, TIMESTAMP, JSON, INTEGER, ForeignKey, Int
 from sqlalchemy.orm import relationship
 
 
+# Table containing reagenttype-kittype relationships
 reagenttypes_kittypes = Table("_reagentstypes_kittypes", Base.metadata, Column("reagent_types_id", INTEGER, ForeignKey("_reagent_types.id")), Column("kits_id", INTEGER, ForeignKey("_kits.id")))
 
 
 class KitType(Base):
-
+    """
+    Base of kits used in submission processing
+    """    
     __tablename__ = "_kits"
 
     id = Column(INTEGER, primary_key=True) #: primary key  
-    name = Column(String(64), unique=True)
-    submissions = relationship("BasicSubmission", back_populates="extraction_kit")
-    used_for = Column(JSON)
-    cost_per_run = Column(FLOAT(2))
-    reagent_types = relationship("ReagentType", back_populates="kits", uselist=True, secondary=reagenttypes_kittypes)
-    reagent_types_id = Column(INTEGER, ForeignKey("_reagent_types.id", ondelete='SET NULL', use_alter=True, name="fk_KT_reagentstype_id"))
+    name = Column(String(64), unique=True) #: name of kit
+    submissions = relationship("BasicSubmission", back_populates="extraction_kit") #: submissions this kit was used for
+    used_for = Column(JSON) #: list of names of sample types this kit can process
+    cost_per_run = Column(FLOAT(2)) #: dollar amount for each full run of this kit
+    reagent_types = relationship("ReagentType", back_populates="kits", uselist=True, secondary=reagenttypes_kittypes) #: reagent types this kit contains
+    reagent_types_id = Column(INTEGER, ForeignKey("_reagent_types.id", ondelete='SET NULL', use_alter=True, name="fk_KT_reagentstype_id")) #: joined reagent type id
     
-    def __str__(self):
+    def __str__(self) -> str:
+        """
+        a string representing this object
+
+        Returns:
+            str: a string representing this object's name
+        """        
         return self.name
     
 
 class ReagentType(Base):
-
+    """
+    Base of reagent type abstract
+    """    
     __tablename__ = "_reagent_types"
 
     id = Column(INTEGER, primary_key=True) #: primary key  
-    name = Column(String(64))
-    kit_id = Column(INTEGER, ForeignKey("_kits.id", ondelete="SET NULL", use_alter=True, name="fk_RT_kits_id"))
-    kits = relationship("KitType", back_populates="reagent_types", uselist=True, foreign_keys=[kit_id])
-    instances = relationship("Reagent", back_populates="type")
+    name = Column(String(64)) #: name of reagent type
+    kit_id = Column(INTEGER, ForeignKey("_kits.id", ondelete="SET NULL", use_alter=True, name="fk_RT_kits_id")) #: id of joined kit type
+    kits = relationship("KitType", back_populates="reagent_types", uselist=True, foreign_keys=[kit_id]) #: kits this reagent is used in
+    instances = relationship("Reagent", back_populates="type") #: concrete instances of this reagent type
     # instances_id = Column(INTEGER, ForeignKey("_reagents.id", ondelete='SET NULL'))
-    eol_ext = Column(Interval())
+    eol_ext = Column(Interval()) #: extension of life interval
 
-    def __str__(self):
+    def __str__(self) -> str:
+        """
+        string representing this object
+
+        Returns:
+            str: string representing this object's name
+        """        
         return self.name
 
 
 class Reagent(Base):
-
+    """
+    Concrete reagent instance
+    """
     __tablename__ = "_reagents"
 
     id = Column(INTEGER, primary_key=True) #: primary key
-    type = relationship("ReagentType", back_populates="instances")
-    type_id = Column(INTEGER, ForeignKey("_reagent_types.id", ondelete='SET NULL', name="fk_reagent_type_id"))
-    name = Column(String(64))
-    lot = Column(String(64))
-    expiry = Column(TIMESTAMP)
-    submissions = relationship("BasicSubmission", back_populates="reagents", uselist=True)
+    type = relationship("ReagentType", back_populates="instances") #: joined parent reagent type
+    type_id = Column(INTEGER, ForeignKey("_reagent_types.id", ondelete='SET NULL', name="fk_reagent_type_id")) #: id of parent reagent type
+    name = Column(String(64)) #: reagent name
+    lot = Column(String(64)) #: lot number of reagent
+    expiry = Column(TIMESTAMP) #: expiry date - extended by eol_ext of parent programmatically
+    submissions = relationship("BasicSubmission", back_populates="reagents", uselist=True) #: submissions this reagent is used in
 
-    def __str__(self):
+    def __str__(self) -> str:
+        """
+        string representing this object
+
+        Returns:
+            str: string representing this object's lot number
+        """        
         return self.lot
 
-    def to_sub_dict(self):
+    def to_sub_dict(self) -> dict:
+        """
+        dictionary containing values necessary for gui
+
+        Returns:
+            dict: gui friendly dictionary
+        """        
         try:
             type = self.type.name.replace("_", " ").title()
         except AttributeError:
@@ -62,7 +93,4 @@ class Reagent(Base):
             "type": type,
             "lot": self.lot,
             "expiry": self.expiry.strftime("%Y-%m-%d")
-        }
-
-    
-    
+        }