Added docstrings to both functions.

Author: adrianoaru-nhs

pages/generate_invitations_page.py

@@ -19,7 +19,12 @@ def click_generate_invitations_button(self):
     def click_refresh_button(self):
         click(self.page, self.refresh_button)
 
-    def wait_for_invitation_generation_complete(self):
+    def wait_for_invitation_generation_complete(self) -> bool:
+        """
+        This function is used to wait for the invitations to be generated.
+        Every 5 seconds it refreshes the table and checks to see if the invitations have been generated.
+        It also checks that enough invitations were generated and checks to see if self referrals are present
+        """
         self.page.wait_for_selector("#displayRS", timeout=5000)
 
         if self.planned_invitations_total == "0":
@@ -55,12 +60,13 @@ def wait_for_invitation_generation_complete(self):
         except Exception as e:
             pytest.fail("Invitations not generated successfully")
 
+        value = self.planned_invitations_total.text_content().strip()  # Get text and remove extra spaces
+        if int(value) < 5:
+            pytest.fail("There are less than 5 invitations generated")
+
         self_referrals_total = int(self.self_referrals_total.text_content().strip())
         if self_referrals_total >= 1:
             return True
         else:
             logging.warning("No S1 Digital Leaflet batch will be generated")
-
-        value = self.planned_invitations_total.text_content().strip()  # Get text and remove extra spaces
-        if int(value) < 5:
-            pytest.fail("There are less than 5 invitations generated")
+            return False

utils/batch_processing.py

@@ -12,7 +12,15 @@
 from playwright.sync_api import Page
 import logging
 
-def batch_processing(page: Page, batch_type: str, batch_description: str, latest_event_status: str, run_timed_events: bool = False):
+def batch_processing(page: Page, batch_type: str, batch_description: str, latest_event_status: str, run_timed_events: bool = False) -> None:
+    """
+    This util is used to process batches. It expects the following inputs:
+    - page: This is playwright page variable
+    - batch_type: This is the event code of the batch. E.g. S1 or S9
+    - batch_description: This is the description of the batch. E.g. Pre-invitation (FIT)
+    - latest_event_status: This is the status the subject will get updated to after the batch has been processed.
+    - run_timed_events: This is an optional input that executes bcss_timed_events if set to True
+    """
     logging.info(f"Processing {batch_type} - {batch_description} batch")
     NavigationBar(page).click_main_menu_link()
     MainMenu(page).go_to_communications_production_page()