Refactoring code

Author: adrianoaru-nhs

classes/address.py

@@ -26,7 +26,7 @@ def set_address_line(self, line_number: int, address_line: str) -> None:
         Raises:
             ValueError: If line_number is not between 1 and 5.
         """
-        logging.info(
+        logging.debug(
             f"start: set_address_line(line_number={line_number}, address_line={address_line})"
         )
         if line_number == 1:
@@ -43,7 +43,7 @@ def set_address_line(self, line_number: int, address_line: str) -> None:
             raise ValueError(
                 f"Invalid line number {line_number}, must be between 1 and 5"
             )
-        logging.info(
+        logging.debug(
             f"end: set_address_line(line_number={line_number}, address_line={address_line})"
         )
 

classes/data/data_creation.py

@@ -107,7 +107,7 @@ def generate_random_subject(
         Returns:
             PISubject: A randomly generated PI Subject.
         """
-        logging.info(
+        logging.debug(
             f"generateRandomSubject: {random_words_list}, {pi_reference}, {region}"
         )
         pi_subject = PISubject()
@@ -138,15 +138,15 @@ def generate_random_subject(
         pi_subject.gnc_code = self.generate_random_registration_code()
         gp_surgery = self.generate_random_gp_surgery(region)
         if gp_surgery is not None:
-            pi_subject.gp_practice_code = gp_surgery.get_code()
+            pi_subject.gp_practice_code = gp_surgery.code
         pi_subject.nhais_deduction_reason = None
         pi_subject.nhais_deduction_date = None
         pi_subject.exeter_system = "ATO"
         pi_subject.removed_to = None
         pi_subject.pi_reference = pi_reference
         pi_subject.superseded_by_nhs_number = None
         pi_subject.replaced_nhs_number = None
-        logging.info("generateRandomSubject: end")
+        logging.debug("generateRandomSubject: end")
         return pi_subject
 
     def generate_random_registration_code(self) -> str:
@@ -155,9 +155,9 @@ def generate_random_registration_code(self) -> str:
         Returns:
             str: The generated registration code
         """
-        logging.info("generateRandomRegistrationCode: start")
+        logging.debug("generateRandomRegistrationCode: start")
         code = random.choice(self.registration_code_list)
-        logging.info("generateRandomRegistrationCode: end")
+        logging.debug("generateRandomRegistrationCode: end")
         return code
 
     def generate_random_gp_surgery(self, region: RegionType) -> Organisation | None:
@@ -168,7 +168,7 @@ def generate_random_gp_surgery(self, region: RegionType) -> Organisation | None:
         Returns:
             Organisation: The generated gp surgery or None if the region type cannot be found
         """
-        logging.info(f"generateRandomGPSurgery: {region}")
+        logging.debug(f"generateRandomGPSurgery: {region}")
         if region == RegionType.ENGLAND:
             return random.choice(self.org_list_england)
         elif region == RegionType.ISLE_OF_MAN:
@@ -184,7 +184,7 @@ def generate_random_address(self, random_words_list: Dict[str, str]) -> Address:
         Returns:
             Address: The generated address
         """
-        logging.info(f"generateRandomAddress: {random_words_list}")
+        logging.debug(f"generateRandomAddress: {random_words_list}")
         address = Address()
         house_number = self.rand.randint(0, 100)
         road_prefix = random_words_list.get("roadPrefix", "")
@@ -204,7 +204,7 @@ def generate_random_address(self, random_words_list: Dict[str, str]) -> Address:
             address.set_address_line(line_number, random_words_list.get("county", ""))
 
         address.set_post_code(self.generate_random_postcode())
-        logging.info("generateRandomAddress: end")
+        logging.debug("generateRandomAddress: end")
         return address
 
     def generate_random_person(
@@ -218,7 +218,7 @@ def generate_random_person(
         Returns:
             Person: The generated person
         """
-        logging.info("generateRandomPerson: start")
+        logging.debug("generateRandomPerson: start")
         if gender not in [GenderType.MALE, GenderType.FEMALE]:
             gender = (
                 GenderType.MALE if self.rand.randint(0, 100) < 50 else GenderType.FEMALE
@@ -235,7 +235,7 @@ def generate_random_person(
         if self.rand.randint(0, 100) < 5:
             person.set_previous_surname(random_words_list.get("surname2", ""))
 
-        logging.info("generateRandomPerson: end")
+        logging.debug("generateRandomPerson: end")
         return person
 
     def generate_random_postcode(self) -> str:
@@ -244,7 +244,7 @@ def generate_random_postcode(self) -> str:
         Returns:
             str: The generated postcode
         """
-        logging.info("generateRandomPostcode: start")
+        logging.debug("generateRandomPostcode: start")
         unused_first_characters = ["V", "Q", "X"]
         inward_letters = [
             "A",
@@ -276,7 +276,7 @@ def generate_random_postcode(self) -> str:
         random_inward_letter1 = random.choice(inward_letters)
         random_inward_letter2 = random.choice(inward_letters)
         postcode = f"{random_outward_letters}{random_outward_digits} {random_inward_digit}{random_inward_letter1}{random_inward_letter2}"
-        logging.info("generateRandomPostcode: end")
+        logging.debug("generateRandomPostcode: end")
         return postcode
 
     def generate_random_title(self, gender: GenderType) -> str:
@@ -287,7 +287,7 @@ def generate_random_title(self, gender: GenderType) -> str:
         Returns:
             str: The generated title
         """
-        logging.info("generateRandomTitle: start")
+        logging.debug("generateRandomTitle: start")
         weighting = self.rand.randint(0, 9)
         if gender == GenderType.FEMALE:
             if weighting > 7:

classes/person.py

@@ -38,7 +38,7 @@ def set_surname(self, surname: str) -> None:
         """
         Sets the surname of the person.
         """
-        logging.info("set surname")
+        logging.debug("set surname")
         self.surname = surname
 
     def get_forename(self) -> str:
@@ -51,7 +51,7 @@ def set_forename(self, forename: str) -> None:
         """
         Sets the forename of the person.
         """
-        logging.info("set forename")
+        logging.debug("set forename")
         self.forename = forename
 
     def get_title(self) -> str:
@@ -64,7 +64,7 @@ def set_title(self, title: str) -> None:
         """
         Sets the title of the person.
         """
-        logging.info("set title")
+        logging.debug("set title")
         self.title = title
 
     def get_other_forenames(self) -> str:
@@ -77,7 +77,7 @@ def set_other_forenames(self, other_forenames: str) -> None:
         """
         Sets other forenames of the person.
         """
-        logging.info("set other_forenames")
+        logging.debug("set other_forenames")
         self.other_forenames = other_forenames
 
     def get_previous_surname(self) -> str:
@@ -90,7 +90,7 @@ def set_previous_surname(self, previous_surname: str) -> None:
         """
         Sets the previous surname of the person.
         """
-        logging.info("set previous_surname")
+        logging.debug("set previous_surname")
         self.previous_surname = previous_surname
 
     def get_gender(self) -> Optional[GenderType]:
@@ -103,5 +103,5 @@ def set_gender(self, gender: GenderType) -> None:
         """
         Sets the gender of the person.
         """
-        logging.info("set gender")
+        logging.debug("set gender")
         self.gender = gender

classes/repositories/general_repository.py

@@ -20,7 +20,7 @@ def run_database_transition(
         """
         Executes the PKG_EPISODE.p_set_episode_next_status stored procedure with the provided parameters.
         """
-        logging.info(
+        logging.debug(
             f"Running database transition with transition_id = {database_transition_parameters.transition_id}"
         )
         conn = self.oracle_db.connect_to_db()
@@ -45,7 +45,7 @@ def run_database_transition(
             assert success, f"Error when executing database transition: {error_rows}"
 
             conn.commit()
-            logging.info("Database transition executed successfully.")
+            logging.debug("Database transition executed successfully.")
         except Exception as e:
             raise oracledb.DatabaseError(f"Error executing database transition: {e}")
         finally:

classes/repositories/investigation_repository.py

@@ -34,7 +34,7 @@ def get_plans(
         Returns:
             List[Any]: [error, plans, weeks]
         """
-        logging.info(
+        logging.debug(
             f"start: get_plans(hub_id={hub_id}, screening_centre_id={screening_centre_id}, plan_id={plan_id})"
         )
         procedure = "PKG_FOBT_CALL.p_get_plans"
@@ -48,21 +48,21 @@ def get_plans(
             raise RuntimeError("Stored procedure did not return any results.")
 
         # Map outputs
-        logging.info("map errorCursor")
+        logging.debug("map errorCursor")
         error_cursor = result[4]  # OUT param 4
         error = DatabaseError.from_cursor(error_cursor)
         if error.is_error():
             raise RuntimeError(f"Database error: {error.get_return_message()}")
 
-        logging.info("map plansCursor")
+        logging.debug("map plansCursor")
         plans_cursor = result[5]
         plans = InvitationPlan.from_cursor(plans_cursor)
 
-        logging.info("map weeksCursor")
+        logging.debug("map weeksCursor")
         week_cursor = result[6]
         weeks = InvitationPlanWeek.from_cursor(week_cursor)
 
-        logging.info("exit: get_plans()")
+        logging.debug("exit: get_plans()")
         return [error, plans, weeks]
 
     def get_active_plan(self, hub_id: int, screening_centre_id: int) -> Optional[dict]:
@@ -76,13 +76,13 @@ def get_active_plan(self, hub_id: int, screening_centre_id: int) -> Optional[dic
         Returns:
             Optional[dict]: The active invitation plan, or None if not found.
         """
-        logging.info(
+        logging.debug(
             f"start: get_active_plan(hub_id={hub_id}, screening_centre_id={screening_centre_id})"
         )
         result_list = self.get_plans(hub_id, screening_centre_id, None)
         all_plans = result_list[1]
         if not all_plans:
-            logging.info("exit: get_active_plan(None)")
+            logging.debug("exit: get_active_plan(None)")
             return None
         else:
             next(
@@ -99,22 +99,22 @@ def refresh_invitation_shortlist(self) -> None:
         Runs the database procedure to refresh the invitations shortlist.
         Picks up any newly self-referred subjects ready for invite.
         """
-        logging.info("start: InvitationRepository.refresh_invitation_shortlist")
+        logging.debug("start: InvitationRepository.refresh_invitation_shortlist")
         procedure = "PKG_FOBT_CALL.p_find_next_subjects_to_invite"
         number_of_weeks = 4
         max_number_of_subjects = 2500
         hub_id = None
         screening_centre_id = None
         params = [number_of_weeks, max_number_of_subjects, hub_id, screening_centre_id]
         self.oracle_db.execute_stored_procedure(procedure, params)
-        logging.info("exit: InvitationRepository.refresh_invitation_shortlist")
+        logging.debug("exit: InvitationRepository.refresh_invitation_shortlist")
 
     def process_next_invitations(self) -> None:
         """
         Runs the database procedure to process the next invitations run waiting to be processed.
         """
-        logging.info("start: InvitationRepository.process_next_invitations")
+        logging.debug("start: InvitationRepository.process_next_invitations")
         procedure = "PKG_FOBT_CALL.p_generate_invitations_next_sc"
         in_params = [None, None, None]
         self.oracle_db.execute_stored_procedure(procedure, in_params)
-        logging.info("exit: InvitationRepository.process_next_invitations")
+        logging.debug("exit: InvitationRepository.process_next_invitations")