Merge branch 'feature/BCSS-22223-refactor-investigation-dataset-util' of github.com:NHSDigital/bcss-playwright into feature/BCSS-22024-seleniumregressiontests-scenario-11

Author: adrianoaru-nhs

investigation_dataset_ui.py

@@ -668,6 +668,51 @@ def _render_drug_entry(fields: list, index: int, result: dict) -> None:
         result[dose_field["key"]] = ddose
 
 
+def _polyp_output_block(
+    pi: int, info_dict: dict, intervention: object, hist_dict: dict
+) -> str:
+    """
+    Generate the code block for a polyp's information, intervention(s), and histology.
+    Args:
+        pi (int): The polyp index (1-based).
+        info_dict (dict): The polyp information dictionary.
+        intervention (object): The polyp intervention(s), can be dict or list of dicts.
+        hist_dict (dict): The polyp histology dictionary.
+    Returns:
+        str: The generated code block.
+    """
+    code_lines = []
+    code_lines.append(
+        f"InvestigationDatasetCompletion(page).fill_polyp_x_information({pretty_dict(info_dict)}, {pi})"
+    )
+    # Intervention
+    if isinstance(intervention, list):
+        if len(intervention) > 1:
+            code_lines.append(
+                f"InvestigationDatasetCompletion(page).fill_polyp_x_multiple_interventions({pretty_list(intervention)}, {pi})"
+            )
+        elif len(intervention) == 1 and isinstance(intervention[0], dict):
+            code_lines.append(
+                f"InvestigationDatasetCompletion(page).fill_polyp_x_intervention({pretty_dict(intervention[0])}, {pi})"
+            )
+        else:
+            code_lines.append(f"# No intervention for polyp {pi}")
+    elif isinstance(intervention, dict):
+        code_lines.append(
+            f"InvestigationDatasetCompletion(page).fill_polyp_x_intervention({pretty_dict(intervention)}, {pi})"
+        )
+    else:
+        code_lines.append(f"# No intervention for polyp {pi}")
+    # Histology
+    if not hist_dict:
+        code_lines.append(f"# No histology for polyp {pi}")
+    else:
+        code_lines.append(
+            f"InvestigationDatasetCompletion(page).fill_polyp_x_histology({pretty_dict(hist_dict)}, {pi})"
+        )
+    return "\n".join(code_lines)
+
+
 def show_polyp_information_and_intervention_and_histology() -> None:
     """
     Show the Polyp Information, Intervention & Histology section, allowing multiple polyps and interventions.
@@ -682,12 +727,11 @@ def show_polyp_information_and_intervention_and_histology() -> None:
     # Collect all fields for import analysis
     all_fields = polyp_info_fields + polyp_intervention_fields + polyp_histology_fields
     enums = get_enums_used(all_fields)
-    if enums:
-        import_block = (
-            enum_import_string + new_indented_line_string.join(sorted(enums)) + "\n)\n"
-        )
-    else:
-        import_block = ""
+    import_block = (
+        enum_import_string + new_indented_line_string.join(sorted(enums)) + "\n)\n"
+        if enums
+        else ""
+    )
 
     num_polyps = st.number_input(
         "Number of polyps", min_value=0, max_value=20, value=1, step=1
@@ -698,55 +742,22 @@ def show_polyp_information_and_intervention_and_histology() -> None:
 
     for pi in range(1, num_polyps + 1):
         st.markdown(f"### Polyp {pi}")
-        polyp_info = _render_polyp_info(polyp_info_fields, pi)
-        polyp_info_dicts[pi] = polyp_info
+        polyp_info_dicts[pi] = _render_polyp_info(polyp_info_fields, pi)
         interventions = _render_interventions(polyp_intervention_fields, pi)
-        # If interventions is a list of length 1, store as dict, else as list
-        if isinstance(interventions, list) and len(interventions) == 1:
-            polyp_interventions_dicts[pi] = interventions[0]
-        else:
-            polyp_interventions_dicts[pi] = interventions
-        polyp_histology = _render_histology(polyp_histology_fields, pi)
-        polyp_histology_dicts[pi] = polyp_histology
+        polyp_interventions_dicts[pi] = (
+            interventions[0]
+            if isinstance(interventions, list) and len(interventions) == 1
+            else interventions
+        )
+        polyp_histology_dicts[pi] = _render_histology(polyp_histology_fields, pi)
 
     st.markdown("#### Output")
-    output_blocks = []
     for pi in range(1, num_polyps + 1):
         info_dict = polyp_info_dicts[pi]
         hist_dict = polyp_histology_dicts[pi]
         intervention = polyp_interventions_dicts[pi]
-        code_lines = []
-        # Information
-        code_lines.append(
-            f"InvestigationDatasetCompletion(page).fill_polyp_x_information({pretty_dict(info_dict)}, {pi})"
-        )
-        # Intervention
-        if isinstance(intervention, list):
-            if len(intervention) > 1:
-                code_lines.append(
-                    f"InvestigationDatasetCompletion(page).fill_polyp_x_multiple_interventions({pretty_list(intervention)}, {pi})"
-                )
-            elif len(intervention) == 1 and isinstance(intervention[0], dict):
-                code_lines.append(
-                    f"InvestigationDatasetCompletion(page).fill_polyp_x_intervention({pretty_dict(intervention[0])}, {pi})"
-                )
-            else:
-                code_lines.append(f"# No intervention for polyp {pi}")
-        elif isinstance(intervention, dict):
-            code_lines.append(
-                f"InvestigationDatasetCompletion(page).fill_polyp_x_intervention({pretty_dict(intervention)}, {pi})"
-            )
-        else:
-            code_lines.append(f"# No intervention for polyp {pi}")
-        # Histology
-        if not hist_dict:
-            code_lines.append(f"# No histology for polyp {pi}")
-        else:
-            code_lines.append(
-                f"InvestigationDatasetCompletion(page).fill_polyp_x_histology({pretty_dict(hist_dict)}, {pi})"
-            )
-        output_blocks.append("\n".join(code_lines))
-        st.code("\n".join(code_lines), language="python")
+        code_block = _polyp_output_block(pi, info_dict, intervention, hist_dict)
+        st.code(code_block, language="python")
     if import_block:
         st.code(import_block, language="python")
 

utils/investigation_dataset.py

@@ -82,6 +82,7 @@ def __init__(self, page: Page):
         self.failure_reasons_string = "Failure Reasons"
         self.excision_technique_string = "Excision Technique"
         self.outcome_at_time_of_procedure_string = "Outcome at time of procedure"
+        self.proof_parameters_string = "Proof Parameters"
 
         self.investigation_datasets_pom = InvestigationDatasetsPage(self.page)
 
@@ -203,7 +204,7 @@ def default_investigation_dataset_forms_continuation(self) -> None:
         self.investigation_datasets_pom.click_show_completion_proof_information()
         # Completion Proof Information
         DatasetFieldUtil(self.page).populate_select_locator_for_field(
-            "Proof Parameters", CompletionProofOptions.PHOTO_ILEO
+            self.proof_parameters_string, CompletionProofOptions.PHOTO_ILEO
         )
 
     def investigation_datasets_failure_reason(self) -> None:
@@ -373,7 +374,7 @@ def complete_dataset_with_args(
         if completion_information is not None:
             logging.info("Filling out completion proof information")
             DatasetFieldUtil(self.page).populate_select_locator_for_field(
-                "Proof Parameters", completion_information["completion proof"]
+                self.proof_parameters_string, completion_information["completion proof"]
             )
 
         # Failure Information
@@ -496,7 +497,7 @@ def fill_out_completion_information(self, completion_information: dict) -> None:
         logging.info("Filling out completion proof information")
         self.investigation_datasets_pom.click_show_completion_proof_information()
         DatasetFieldUtil(self.page).populate_select_locator_for_field(
-            "Proof Parameters", completion_information["completion proof"]
+            self.proof_parameters_string, completion_information["completion proof"]
         )
 
     def fill_out_failure_information(self, failure_information: dict) -> None: