Fixing incorrectly converted classes

Standardising capitalisation of Yes / No
Converted classes to Enums where necessary

Author: adrianoaru-nhs

classes/address/address.py

@@ -1,19 +1,19 @@
-import logging
+from dataclasses import dataclass
 
 
+@dataclass
 class Address:
     """
     Represents a postal address with up to five address lines and a postcode.
-    Provides methods to set individual lines and to format the address as a string.
+    Provides methods to format the address as a string.
     """
 
-    def __init__(self) -> None:
-        self.address_line1: str = ""
-        self.address_line2: str = ""
-        self.address_line3: str = ""
-        self.address_line4: str = ""
-        self.address_line5: str = ""
-        self.post_code: str = ""
+    address_line1: str = ""
+    address_line2: str = ""
+    address_line3: str = ""
+    address_line4: str = ""
+    address_line5: str = ""
+    post_code: str = ""
 
     def set_address_line(self, line_number: int, address_line: str) -> None:
         """
@@ -26,9 +26,6 @@ def set_address_line(self, line_number: int, address_line: str) -> None:
         Raises:
             ValueError: If line_number is not between 1 and 5.
         """
-        logging.debug(
-            f"start: set_address_line(line_number={line_number}, address_line={address_line})"
-        )
         if line_number == 1:
             self.address_line1 = address_line
         elif line_number == 2:
@@ -43,9 +40,6 @@ 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.debug(
-            f"end: set_address_line(line_number={line_number}, address_line={address_line})"
-        )
 
     def __str__(self) -> str:
         """
@@ -59,77 +53,4 @@ def __str__(self) -> str:
             self.address_line5,
             self.post_code,
         ]
-        # Filter out empty or None values and join with ', '
         return ", ".join([part for part in address_parts if part])
-
-    def get_address_line1(self) -> str:
-        """
-        Returns the first address line.
-        """
-        return self.address_line1
-
-    def set_address_line1(self, address_line1: str) -> None:
-        """
-        Sets the first address line.
-        """
-        self.address_line1 = address_line1
-
-    def get_address_line2(self) -> str:
-        """
-        Returns the second address line.
-        """
-        return self.address_line2
-
-    def set_address_line2(self, address_line2: str) -> None:
-        """
-        Sets the second address line.
-        """
-        self.address_line2 = address_line2
-
-    def get_address_line3(self) -> str:
-        """
-        Returns the third address line.
-        """
-        return self.address_line3
-
-    def set_address_line3(self, address_line3: str) -> None:
-        """
-        Sets the thrid address line.
-        """
-        self.address_line3 = address_line3
-
-    def get_address_line4(self) -> str:
-        """
-        Returns the fourth address line.
-        """
-        return self.address_line4
-
-    def set_address_line4(self, address_line4: str) -> None:
-        """
-        Sets the fourth address line.
-        """
-        self.address_line4 = address_line4
-
-    def get_address_line5(self) -> str:
-        """
-        Returns the fifth address line.
-        """
-        return self.address_line5
-
-    def set_address_line5(self, address_line5: str) -> None:
-        """
-        Sets the fifth address line.
-        """
-        self.address_line5 = address_line5
-
-    def get_post_code(self) -> str:
-        """
-        Returns the postcodde.
-        """
-        return self.post_code
-
-    def set_post_code(self, post_code: str) -> None:
-        """
-        Sets the postcode.
-        """
-        self.post_code = post_code

classes/appointment/appointment_slot_type.py

@@ -0,0 +1,67 @@
+from enum import Enum
+from typing import Optional
+
+
+class AppointmentSlotType(Enum):
+    """
+    Enum representing appointment slot types, mapped to valid value IDs and descriptions.
+    Provides utility methods for lookup by description (case-sensitive and insensitive) and by valid value ID.
+    """
+
+    COLONOSCOPY_ASSESSMENT = (209028, "Colonoscopy Assessment")
+    BOWEL_SCOPE_AUTOMATIC = (200526, "FS Automatic")
+    BOWEL_SCOPE_MANUAL = (200527, "FS Manual")
+    POSITIVE_ASSESSMENT = (6016, "Positive Assessment")
+    POST_INVESTIGATION = (6017, "Post-Investigation")
+    SURVEILLANCE = (20061, "Surveillance")
+
+    def __init__(self, valid_value_id: int, description: str) -> None:
+        self._valid_value_id = valid_value_id
+        self._description = description
+
+    @property
+    def valid_value_id(self) -> int:
+        """
+        Returns the valid value ID for the appointment slot type.
+        """
+        return self._valid_value_id
+
+    @property
+    def description(self) -> str:
+        """
+        Returns the description for the appointment slot type.
+        """
+        return self._description
+
+    @classmethod
+    def by_description(cls, description: str) -> Optional["AppointmentSlotType"]:
+        """
+        Returns the enum member matching the given description (case-sensitive).
+        """
+        for member in cls:
+            if member.description == description:
+                return member
+        return None
+
+    @classmethod
+    def by_description_case_insensitive(
+        cls, description: str
+    ) -> Optional["AppointmentSlotType"]:
+        """
+        Returns the enum member matching the given description (case-insensitive).
+        """
+        desc_lower = description.lower()
+        for member in cls:
+            if member.description.lower() == desc_lower:
+                return member
+        return None
+
+    @classmethod
+    def by_valid_value_id(cls, valid_value_id: int) -> Optional["AppointmentSlotType"]:
+        """
+        Returns the enum member matching the given valid value ID.
+        """
+        for member in cls:
+            if member.valid_value_id == valid_value_id:
+                return member
+        return None

classes/appointment/appointment_status_type.py

@@ -1,39 +1,66 @@
-class AppointmentStatusType:
-    """
-    Utility class for mapping descriptive appointment statuses to internal IDs.
+from enum import Enum
+from typing import Optional
 
-    This class provides a mapping between human-readable appointment status descriptions
-    (such as "booked", "attended", "cancelled", "dna") and their corresponding internal
-    integer IDs used in the system.
 
-    Methods:
-        get_id(description: str) -> int:
-            Returns the internal ID for a given appointment status description.
-            Raises ValueError if the description is not recognized.
+class AppointmentStatusType(Enum):
+    """
+    Enum representing appointment status types, mapped to valid value IDs and descriptions.
     """
 
-    _mapping = {
-        "booked": 2001,
-        "attended": 2002,
-        "cancelled": 2003,
-        "dna": 2004,  # Did Not Attend
-    }
+    ATTENDED = (6121, "Attended")
+    BOOKED = (6120, "Booked")
+    CANCELLED = (6122, "Cancelled")
+    DID_NOT_ATTEND = (6123, "Did Not Attend")
 
-    @classmethod
-    def get_id(cls, description: str) -> int:
+    def __init__(self, valid_value_id: int, description: str) -> None:
+        self._valid_value_id = valid_value_id
+        self._description = description
+
+    @property
+    def valid_value_id(self) -> int:
+        """
+        Returns the valid value ID for the appointment status type.
+        """
+        return self._valid_value_id
+
+    @property
+    def description(self) -> str:
+        """
+        Returns the description for the appointment status type.
         """
-        Returns the internal ID for a given appointment status description.
+        return self._description
 
-        Args:
-            description (str): The appointment status description (e.g., "booked").
+    @classmethod
+    def by_description(cls, description: str) -> Optional["AppointmentStatusType"]:
+        """
+        Returns the enum member matching the given description (case-sensitive).
+        """
+        for member in cls:
+            if member.description == description:
+                return member
+        return None
 
-        Returns:
-            int: The internal ID corresponding to the description.
+    @classmethod
+    def by_description_case_insensitive(
+        cls, description: str
+    ) -> Optional["AppointmentStatusType"]:
+        """
+        Returns the enum member matching the given description (case-insensitive).
+        """
+        desc_lower = description.lower()
+        for member in cls:
+            if member.description.lower() == desc_lower:
+                return member
+        return None
 
-        Raises:
-            ValueError: If the description is not recognized.
+    @classmethod
+    def by_valid_value_id(
+        cls, valid_value_id: int
+    ) -> Optional["AppointmentStatusType"]:
+        """
+        Returns the enum member matching the given valid value ID.
         """
-        key = description.strip().lower()
-        if key not in cls._mapping:
-            raise ValueError(f"Unknown appointment status: {description}")
-        return cls._mapping[key]
+        for member in cls:
+            if member.valid_value_id == valid_value_id:
+                return member
+        return None

classes/appointment/appointments_slot_type.py

@@ -20,10 +20,10 @@ class ManualCeaseRequested(Enum):
             Returns the enum member matching the given description (case-insensitive), or None if not found.
     """
 
-    NO = "no"
-    DISCLAIMER_LETTER_REQUIRED = "yes - disclaimer letter required (c1)"
-    DISCLAIMER_LETTER_SENT = "yes - disclaimer letter sent (c2)"
-    YES = "yes"
+    NO = "No"
+    DISCLAIMER_LETTER_REQUIRED = "Yes - disclaimer letter required (C1)"
+    DISCLAIMER_LETTER_SENT = "Yes - disclaimer letter sent (C2)"
+    YES = "Yes"
 
     def __init__(self, description: str) -> None:
         """

classes/ceased/manual_cease_requested.py

@@ -129,12 +129,12 @@ def generate_random_subject(
         else:
             pi_subject.gender_code = GenderType.NOT_KNOWN.redefined_value
         address = self.generate_random_address(random_words_list)
-        pi_subject.address_line_1 = address.get_address_line1()
-        pi_subject.address_line_2 = address.get_address_line2()
-        pi_subject.address_line_3 = address.get_address_line3()
-        pi_subject.address_line_4 = address.get_address_line4()
-        pi_subject.address_line_5 = address.get_address_line5()
-        pi_subject.postcode = address.get_post_code()
+        pi_subject.address_line_1 = address.address_line1
+        pi_subject.address_line_2 = address.address_line2
+        pi_subject.address_line_3 = address.address_line3
+        pi_subject.address_line_4 = address.address_line4
+        pi_subject.address_line_5 = address.address_line5
+        pi_subject.postcode = address.post_code
         pi_subject.gnc_code = self.generate_random_registration_code()
         gp_surgery = self.generate_random_gp_surgery(region)
         if gp_surgery is not None:
@@ -203,7 +203,7 @@ def generate_random_address(self, random_words_list: Dict[str, str]) -> Address:
             line_number += 1
             address.set_address_line(line_number, random_words_list.get("county", ""))
 
-        address.set_post_code(self.generate_random_postcode())
+        address.post_code = self.generate_random_postcode()
         logging.debug("generateRandomAddress: end")
         return address