Tips Writer finished.

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

@@ -154,7 +154,7 @@ class BasicSubmission(BaseClass):
         dicto = dict(
             details_ignore=['excluded', 'reagents', 'samples',
                             'extraction_info', 'comment', 'barcode',
-                            'platemap', 'export_map', 'equipment'],
+                            'platemap', 'export_map', 'equipment', 'tips'],
             # NOTE: Fields not placed in ui form
             form_ignore=['reagents', 'ctx', 'id', 'cost', 'extraction_info', 'signed_by', 'comment'] + recover,
             # NOTE: Fields not placed in ui form to be moved to pydantic

src/submissions/backend/excel/writer.py

@@ -57,6 +57,7 @@ class SheetWriter(object):
         self.write_reagents()
         self.write_samples()
         self.write_equipment()
+        self.write_tips()
 
     def write_info(self):
         disallowed = ['filepath', 'reagents', 'samples', 'equipment', 'controls']
@@ -80,6 +81,11 @@ class SheetWriter(object):
         writer = EquipmentWriter(xl=self.xl, submission_type=self.submission_type, equipment_list=equipment_list)
         self.xl = writer.write_equipment()
 
+    def write_tips(self):
+        tips_list = self.sub['tips']
+        writer = TipWriter(xl=self.xl, submission_type=self.submission_type, tips_list=tips_list)
+        self.xl = writer.write_tips()
+
 
 class InfoWriter(object):
 
@@ -271,3 +277,64 @@ class EquipmentWriter(object):
                     logger.error(f"Couldn't write to {equipment['sheet']}, row: {v['row']}, column: {v['column']}")
                     logger.error(e)
         return self.xl
+
+
+class TipWriter(object):
+
+    def __init__(self, xl: Workbook, submission_type: SubmissionType | str, tips_list: list):
+        if isinstance(submission_type, str):
+            submission_type = SubmissionType.query(name=submission_type)
+        self.submission_type = submission_type
+        self.xl = xl
+        tips_map = self.submission_type.construct_tips_map()
+        self.tips = self.reconcile_map(tips_list=tips_list, tips_map=tips_map)
+
+    def reconcile_map(self, tips_list: list, tips_map: list):
+        output = []
+        if tips_list is None:
+            return output
+        for ii, tips in enumerate(tips_list, start=1):
+            mp_info = tips_map[tips['role']]
+            # logger.debug(f"{tips['role']} map: {mp_info}")
+            placeholder = copy(tips)
+            if mp_info == {}:
+                for jj, (k, v) in enumerate(tips.items(), start=1):
+                    dicto = dict(value=v, row=ii, column=jj)
+                    placeholder[k] = dicto
+            else:
+                for jj, (k, v) in enumerate(tips.items(), start=1):
+                    try:
+                        dicto = dict(value=v, row=mp_info[k]['row'], column=mp_info[k]['column'])
+                    except KeyError as e:
+                        # logger.error(f"Keyerror: {e}")
+                        continue
+                    placeholder[k] = dicto
+            try:
+                placeholder['sheet'] = mp_info['sheet']
+            except KeyError:
+                placeholder['sheet'] = "Tips"
+            # logger.debug(f"Final output of {tips['role']} : {placeholder}")
+            output.append(placeholder)
+        return output
+
+    def write_tips(self):
+        for tips in self.tips:
+            try:
+                sheet = self.xl[tips['sheet']]
+            except KeyError:
+                self.xl.create_sheet("Tips")
+            finally:
+                sheet = self.xl[tips['sheet']]
+            for k, v in tips.items():
+                if not isinstance(v, dict):
+                    continue
+                # logger.debug(
+                #     f"Writing {k}: {v['value']} to {equipment['sheet']}, row: {v['row']}, column: {v['column']}")
+                if isinstance(v['value'], list):
+                    v['value'] = v['value'][0]
+                try:
+                    sheet.cell(row=v['row'], column=v['column'], value=v['value'])
+                except AttributeError as e:
+                    logger.error(f"Couldn't write to {tips['sheet']}, row: {v['row']}, column: {v['column']}")
+                    logger.error(e)
+        return self.xl

src/submissions/backend/validators/pydant.py

@@ -731,7 +731,7 @@ class PydSubmission(BaseModel, extra='allow'):
                     for tips in self.tips:
                         if tips is None:
                             continue
-                        association = tips.to_sql()
+                        association = tips.to_sql(submission=instance)
                         if association is not None:
                             # association.save()
                             instance.submission_tips_associations.append(association)