Addressing PR comments

Author: adrianoaru-nhs

classes/pi_subject.py

@@ -87,7 +87,7 @@ def from_subject(subject: "Subject") -> "PISubject":
         if gender is not None:
             gender_code = gender.redefined_value
         else:
-            gender_code = 0  # If None setting to "Not known gender"
+            gender_code = 0  # If None, set to "Not known gender"
         return PISubject(
             screening_subject_id=subject.screening_subject_id,
             nhs_number=subject.nhs_number,

classes/subject.py

@@ -1307,6 +1307,13 @@ def from_dataframe_row(row: pd.Series) -> "Subject":
         return Subject(**field_map)
 
     def populate_subject_object_from_nhs_no(self, nhs_no: str) -> "Subject":
+        """
+        Populates a Subject object from the NHS number.
+        Args:
+            nhs_no (str): The NHS number to populate the subject from.
+        Returns:
+            Subject: A populated Subject object from the database
+        """
         from utils.oracle.subject_selection_query_builder import (
             SubjectSelectionQueryBuilder,
         )

pages/screening_practitioner_appointments/appointment_detail_page.py

@@ -82,6 +82,7 @@ def select_reason_for_cancellation_option(self, option: str) -> None:
         Selects the reason for cancellation from the dropdown.
         Args:
             option: The reason for cancellation to select.
+            The options are in the ReasonForCancellationOptions class
         """
         self.reason_for_cancellation_dropwdown.select_option(value=option)
 

utils/appointments.py

@@ -85,32 +85,35 @@ def book_appointments(page: Page, screening_centre: str, site: str) -> None:
         page (Page): The Playwright page object.
         screening_centre (str): The name of the screening centre.
         site (str): The name of the site.
+    Raises:
+        RuntimeError: If the appointment booking confirmation is not displayed.
     """
-    BookAppointmentPage(page).select_screening_centre_dropdown_option(screening_centre)
-    BookAppointmentPage(page).select_site_dropdown_option(
+    book_appointments_page = BookAppointmentPage(page)
+    book_appointments_page.select_screening_centre_dropdown_option(screening_centre)
+    book_appointments_page.select_site_dropdown_option(
         [
             f"{site} (? km)",
             f"{site} (? km) (attended)",
         ]
     )
 
     # And I book the "earliest" available practitioner appointment on this date
-    current_month_displayed = BookAppointmentPage(page).get_current_month_displayed()
+    current_month_displayed = book_appointments_page.get_current_month_displayed()
     CalendarPicker(page).book_first_eligible_appointment(
         current_month_displayed,
-        BookAppointmentPage(page).appointment_cell_locators,
+        book_appointments_page.appointment_cell_locators,
         [
-            BookAppointmentPage(page).available_background_colour,
-            BookAppointmentPage(page).some_available_background_colour,
+            book_appointments_page.available_background_colour,
+            book_appointments_page.some_available_background_colour,
         ],
     )
     page.wait_for_timeout(500)  # Wait for the appointments to load
-    BookAppointmentPage(page).appointments_table.click_first_input_in_column(
+    book_appointments_page.appointments_table.click_first_input_in_column(
         "Appt/Slot Time"
     )
-    BasePage(page).safe_accept_dialog(BookAppointmentPage(page).save_button)
+    BasePage(page).safe_accept_dialog(book_appointments_page.save_button)
     try:
-        BookAppointmentPage(page).appointment_booked_confirmation_is_displayed(
+        book_appointments_page.appointment_booked_confirmation_is_displayed(
             "Appointment booked"
         )
         logging.info("[BOOK APPOINTMENTS] Appointment successfully booked")

utils/date_time_utils.py

@@ -213,7 +213,11 @@ def parse_datetime(
     @staticmethod
     def calculate_birth_date_for_age(age: int) -> date:
         """
-        Calculates the birth date for a given age.
+        Calculates a birth date corresponding to a given age as of today's date.
+
+        This method subtracts the specified age from the current year to estimate the birth date.
+        If the resulting date would fall on February 29 in a non-leap year, it adjusts to February 28
+        to ensure a valid date.
         Args:
             age (int): The age to calculate the birth date for.
         Returns:

utils/sspi_change_steps.py

@@ -31,7 +31,7 @@ def sspi_update_to_change_dob_received(
 
         logging.debug("exit: sspi_update_to_change_dob_received()")
 
-    def handle_update(self, subject, birth_date: Optional[date]) -> None:
+    def handle_update(self, subject: Subject, birth_date: Optional[date]) -> None:
         """
         Performs the SSPI update to make the changes in the database.
         Args: