Adding docstrings and addressing PR comments

adrianoaru-nhs · adrianoaru-nhs · commit 742e900224a9 · 2025-07-29T15:14:46.000+01:00
diff --git a/classes/asa_grade_type.py b/classes/asa_grade_type.py
@@ -33,6 +33,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for ASAGradeType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, ASAGradeType] = {}
             cls._lowercase_descriptions: Dict[str, ASAGradeType] = {}
diff --git a/classes/cancer_treatment_intent.py b/classes/cancer_treatment_intent.py
@@ -29,6 +29,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for CanterTreatmentIntent enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, CancerTreatmentIntent] = {}
             cls._lowercase_descriptions: Dict[str, CancerTreatmentIntent] = {}
diff --git a/classes/diagnosis_date_reason_type.py b/classes/diagnosis_date_reason_type.py
@@ -19,7 +19,7 @@ class DiagnosisDateReasonType(Enum):
     PATIENT_CHOICE = (305522, "Patient choice")
     PATIENT_COULD_NOT_BE_CONTACTED = (305505, "Patient could not be contacted")
     PATIENT_DECEASED = (305503, "Patient deceased")
-    PATIENT_DECLINIED_ALL_APPOINTMENTS = (305520, "Patient declined all appointments")
+    PATIENT_DECLINED_ALL_APPOINTMENTS = (305520, "Patient declined all appointments")
     PATIENT_EMIGRATED = (305504, "Patient emigrated")
     REOPENED_OLD_EPISODE_DATE_UNKNOWN = (305502, "Reopened old episode, date unknown")
     SSPI_UPDATE_PATIENT_DECEASED = (305525, "SSPI update - patient deceased")
@@ -47,6 +47,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for DiagnosisDateReasonType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, DiagnosisDateReasonType] = {}
             cls._lowercase_descriptions: Dict[str, DiagnosisDateReasonType] = {}
diff --git a/classes/diagnostic_test_referral_type.py b/classes/diagnostic_test_referral_type.py
@@ -26,6 +26,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for DiagnosticTestReferralType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, DiagnosticTestReferralType] = {}
             cls._lowercase_descriptions: Dict[str, DiagnosticTestReferralType] = {}
diff --git a/classes/episode_status_reason_type.py b/classes/episode_status_reason_type.py
@@ -92,6 +92,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for EpisodeStatusReasonType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, EpisodeStatusReasonType] = {}
             cls._lowercase_descriptions: Dict[str, EpisodeStatusReasonType] = {}
@@ -137,6 +143,6 @@ def get_id(self) -> Optional[int]:
 
     def get_description(self) -> str:
         """
-        Returns
+        Returns the description for the episode status reason.
         """
         return self._description
diff --git a/classes/episode_status_type.py b/classes/episode_status_type.py
@@ -28,6 +28,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for EpisodeStatusType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, EpisodeStatusType] = {}
             cls._lowercase_descriptions: Dict[str, EpisodeStatusType] = {}
@@ -71,6 +77,6 @@ def get_id(self) -> int:
 
     def get_description(self) -> str:
         """
-        Returns the description for the
+        Returns the description for the episode status.
         """
         return self._description
diff --git a/classes/episode_sub_type.py b/classes/episode_sub_type.py
@@ -51,9 +51,10 @@ def description(self) -> str:
     @classmethod
     def _build_maps(cls) -> None:
         """
-        Builds internal lookup maps for descriptions and valid value IDs.
+        Initializes internal lookup maps for EpisodeSubType enum members.
 
-        This method is called automatically before lookups.
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
         """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, EpisodeSubType] = {}
diff --git a/classes/event_code_type.py b/classes/event_code_type.py
@@ -405,6 +405,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for EventCodeType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_codes"):
             cls._codes: Dict[str, EventCodeType] = {}
             cls._descriptions: Dict[str, EventCodeType] = {}
diff --git a/classes/final_pretreatment_m_category_type.py b/classes/final_pretreatment_m_category_type.py
@@ -28,6 +28,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for FinalPretreatmentMCategoryType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, FinalPretreatmentMCategoryType] = {}
             cls._lowercase_descriptions: Dict[str, FinalPretreatmentMCategoryType] = {}
diff --git a/classes/final_pretreatment_n_category_type.py b/classes/final_pretreatment_n_category_type.py
@@ -30,6 +30,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for FinalPretreatmentNCategoryType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, FinalPretreatmentNCategoryType] = {}
             cls._lowercase_descriptions: Dict[str, FinalPretreatmentNCategoryType] = {}
diff --git a/classes/final_pretreatment_t_category_type.py b/classes/final_pretreatment_t_category_type.py
@@ -38,6 +38,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for FinalPretreatmentTCategoryType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, FinalPretreatmentTCategoryType] = {}
             cls._lowercase_descriptions: Dict[str, FinalPretreatmentTCategoryType] = {}
diff --git a/classes/location_type.py b/classes/location_type.py
@@ -51,6 +51,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for LocationType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, LocationType] = {}
             cls._lowercase_descriptions: Dict[str, LocationType] = {}
diff --git a/classes/metastases_location_type.py b/classes/metastases_location_type.py
@@ -30,6 +30,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for MetastasesLocationType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, MetastasesLocationType] = {}
             cls._lowercase_descriptions: Dict[str, MetastasesLocationType] = {}
diff --git a/classes/metastases_present_type.py b/classes/metastases_present_type.py
@@ -28,6 +28,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for MetastasesPresentType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, MetastasesPresentType] = {}
             cls._lowercase_descriptions: Dict[str, MetastasesPresentType] = {}
diff --git a/classes/previously_excised_tumour_type.py b/classes/previously_excised_tumour_type.py
@@ -29,6 +29,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for PreviouslyExcisedTumorType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, PreviouslyExcisedTumourType] = {}
             cls._lowercase_descriptions: Dict[str, PreviouslyExcisedTumourType] = {}
diff --git a/classes/reason_for_onward_referral_type.py b/classes/reason_for_onward_referral_type.py
@@ -36,6 +36,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for ReasonForOnwardReferralType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, ReasonForOnwardReferralType] = {}
             cls._lowercase_descriptions: Dict[str, ReasonForOnwardReferralType] = {}
diff --git a/classes/reason_for_symptomatic_referral_type.py b/classes/reason_for_symptomatic_referral_type.py
@@ -27,6 +27,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for ReasonForSymptomatcRefferalType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, ReasonForSymptomaticReferralType] = {}
             cls._lowercase_descriptions: Dict[str, ReasonForSymptomaticReferralType] = (
diff --git a/classes/reason_no_treatment_received_type.py b/classes/reason_no_treatment_received_type.py
@@ -31,6 +31,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for ReasonNoTreatmentReceivedType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, ReasonNoTreatmentReceivedType] = {}
             cls._lowercase_descriptions: Dict[str, ReasonNoTreatmentReceivedType] = {}
diff --git a/classes/recall_calculation_method_type.py b/classes/recall_calculation_method_type.py
@@ -39,6 +39,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for RecallCalculationMethodType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, RecallCalculationMethodType] = {}
             cls._lowercase_descriptions: Dict[str, RecallCalculationMethodType] = {}
diff --git a/classes/recall_episode_type.py b/classes/recall_episode_type.py
@@ -35,6 +35,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for RecallEpisodeType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, RecallEpisodeType] = {}
             cls._lowercase_descriptions: Dict[str, RecallEpisodeType] = {}
diff --git a/classes/recall_surveillance_type.py b/classes/recall_surveillance_type.py
@@ -11,7 +11,10 @@ class RecallSurveillanceType(Enum):
     INTERMEDIATE_RISK = (11431, "Intermediate Risk")
     LNPCP = (305612, "LNPCP")
     HIGH_RISK_FINDINGS = (305613, "High-risk findings")
-    NULL = (None, "Null")
+    NULL = (
+        None,
+        "Null",
+    )  # The valid value id for this is None, and the descition is "Null"
 
     def __init__(self, valid_value_id: Optional[int], description: str):
         self._valid_value_id: Optional[int] = valid_value_id
@@ -29,6 +32,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for RecallSurveillanceType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, RecallSurveillanceType] = {}
             cls._lowercase_descriptions: Dict[str, RecallSurveillanceType] = {}
diff --git a/classes/scan_type.py b/classes/scan_type.py
@@ -31,6 +31,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for ScanType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, ScanType] = {}
             cls._lowercase_descriptions: Dict[str, ScanType] = {}
diff --git a/classes/treatment_given.py b/classes/treatment_given.py
@@ -33,6 +33,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for TreatmentGiven enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, TreatmentGiven] = {}
             cls._lowercase_descriptions: Dict[str, TreatmentGiven] = {}
diff --git a/classes/treatment_type.py b/classes/treatment_type.py
@@ -27,6 +27,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for TreatmentType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, TreatmentType] = {}
             cls._lowercase_descriptions: Dict[str, TreatmentType] = {}
diff --git a/classes/yes_no.py b/classes/yes_no.py
@@ -20,6 +20,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for YesNo enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, YesNo] = {}
             cls._lowercase_descriptions: Dict[str, YesNo] = {}
diff --git a/classes/yes_no_type.py b/classes/yes_no_type.py
@@ -27,6 +27,12 @@ def description(self) -> str:
 
     @classmethod
     def _build_maps(cls) -> None:
+        """
+        Initializes internal lookup maps for YesNoType enum members.
+
+        It ensures these maps are built only once per class, using `hasattr` to prevent
+        redundant reinitialization.
+        """
         if not hasattr(cls, "_descriptions"):
             cls._descriptions: Dict[str, YesNoType] = {}
             cls._lowercase_descriptions: Dict[str, YesNoType] = {}
