Merge branch 'main' into feature/BCSS-20586-selenium-to-playwright-organisation

# Conflicts:
#	utils/oracle/oracle_specific_functions.py

Author: mepr1

README.md

@@ -0,0 +1,135 @@
+import logging
+
+
+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.
+    """
+
+    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 = ""
+
+    def set_address_line(self, line_number: int, address_line: str) -> None:
+        """
+        Sets the specified address line (1-5) to the given value.
+
+        Args:
+            line_number (int): The address line number (1-5).
+            address_line (str): The value to set for the address line.
+
+        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:
+            self.address_line2 = address_line
+        elif line_number == 3:
+            self.address_line3 = address_line
+        elif line_number == 4:
+            self.address_line4 = address_line
+        elif line_number == 5:
+            self.address_line5 = address_line
+        else:
+            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:
+        """
+        Returns the formatted address as a single string.
+        """
+        address_parts = [
+            self.address_line1,
+            self.address_line2,
+            self.address_line3,
+            self.address_line4,
+            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/address.py

@@ -0,0 +1,61 @@
+from dataclasses import dataclass
+from typing import Optional
+import pandas as pd
+
+
+@dataclass
+class Analyser:
+    """
+    This data class is used to store information about a specific analyser device.
+    The attributes correspond to the columns in the analyser query results.
+    Attributes:
+        analyser_id (Optional[int]): The ID of the analyser.
+        analyser_code (Optional[str]): The code of the analyser.
+        hub_id (Optional[int]): The ID of the hub the analyser is connected to.
+        analyser_type_id (Optional[int]): The type ID of the analyser.
+        spoil_result_code (Optional[int]): The result code for spoilage.
+        tech_fail_result_code (Optional[int]): The result code for technical failure.
+        below_range_result_code (Optional[int]): The result code for below range.
+        above_range_result_code (Optional[int]): The result code for above range.
+    """
+
+    analyser_id: Optional[int] = None
+    analyser_code: Optional[str] = None
+    hub_id: Optional[int] = None
+    analyser_type_id: Optional[int] = None
+    spoil_result_code: Optional[int] = None
+    tech_fail_result_code: Optional[int] = None
+    below_range_result_code: Optional[int] = None
+    above_range_result_code: Optional[int] = None
+
+    def __str__(self) -> str:
+        return (
+            f"Analyser [analyser_id={self.analyser_id}, analyser_code={self.analyser_code}, "
+            f"hub_id={self.hub_id}, spoil_result_code={self.spoil_result_code}, "
+            f"tech_fail_result_code={self.tech_fail_result_code}, "
+            f"below_range_result_code={self.below_range_result_code}, "
+            f"above_range_result_code={self.above_range_result_code}]"
+        )
+
+    @staticmethod
+    def from_dataframe_row(row: pd.Series) -> "Analyser":
+        """
+        Creates an Analyser object from a pandas DataFrame row containing analyser query results.
+
+        Args:
+            row (pd.Series): A row from a pandas DataFrame with columns:
+                - tk_analyser_id
+                - analyser_code
+                - hub_id
+                - tk_analyser_type_id
+            The other columns are obtained from the SQL query as so are not present in this method.
+
+        Returns:
+            Analyser: The constructed Analyser object.
+        """
+        return Analyser(
+            analyser_id=row.get("tk_analyser_id"),
+            analyser_code=row.get("analyser_code"),
+            hub_id=row.get("hub_id"),
+            analyser_type_id=row.get("tk_analyser_type_id"),
+        )

classes/analyser.py

@@ -0,0 +1,66 @@
+from enum import Enum
+from typing import Optional
+
+
+class AnalyserResultCodeType(Enum):
+    """
+    Enum for analyser result code types, mapped to valid value IDs and descriptions.
+    """
+
+    ABOVE_DILUTION_RANGE = (309030, "Above dilution range")
+    BELOW_MEASURING_RANGE = (309028, "Below measuring range")
+    SPOILT = (309026, "Spoilt")
+    TECHNICAL_FAIL = (309027, "Technical Fail")
+
+    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 analyser result code type.
+        """
+        return self._valid_value_id
+
+    @property
+    def description(self) -> str:
+        """
+        Returns the description for the analyser result code type.
+        """
+        return self._description
+
+    @classmethod
+    def by_description(cls, description: str) -> Optional["AnalyserResultCodeType"]:
+        """
+        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["AnalyserResultCodeType"]:
+        """
+        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["AnalyserResultCodeType"]:
+        """
+        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