orionis 0.405.0__py3-none-any.whl → 0.406.0__py3-none-any.whl

orionis/test/entities/result.py

@@ -5,7 +5,14 @@ from orionis.test.enums import TestStatus
 @dataclass(frozen=True, kw_only=True)
 class TestResult:
     """
-    Represents the result of a test execution, including status, timing, and error details.
+    Data class representing the outcome of a test execution.
+
+    This class encapsulates all relevant information about a test's execution,
+    including its unique identifier, name, execution status, timing, and any
+    error details if the test did not pass. It also stores optional metadata
+    such as the class, method, module, file path, and docstring associated
+    with the test, if applicable.
+
     Attributes:
         id (Any): Unique identifier for the test result.
         name (str): Name of the test.
@@ -18,33 +25,40 @@ class TestResult:
         module (Optional[str]): Name of the module containing the test, if applicable.
         file_path (Optional[str]): Path to the file containing the test, if applicable.
         doc_string (Optional[str]): Docstring of the test, if applicable.
-    """
 
+    Returns:
+        TestResult: An immutable instance containing all details about a single test execution.
+    """
 
+    # Unique identifier for the test result
     id: Any = field(
         metadata={
             "description": "Unique identifier for the test result."
         }
     )
 
+    # Name of the test
     name: str = field(
         metadata={
             "description": "Name of the test."
         }
     )
 
+    # Status of the test execution (e.g., passed, failed)
     status: TestStatus = field(
         metadata={
             "description": "Status of the test execution (e.g., passed, failed)."
         }
     )
 
+    # Time taken to execute the test, in seconds
     execution_time: float = field(
         metadata={
             "description": "Time taken to execute the test, in seconds."
         }
     )
 
+    # Error message if the test failed, otherwise None
     error_message: Optional[str] = field(
         default=None,
         metadata={
@@ -52,6 +66,7 @@ class TestResult:
         }
     )
 
+    # Traceback information if an error occurred, otherwise None
     traceback: Optional[str] = field(
         default=None,
         metadata={
@@ -59,6 +74,7 @@ class TestResult:
         }
     )
 
+    # Name of the class containing the test, if applicable
     class_name: Optional[str] = field(
         default=None,
         metadata={
@@ -66,6 +82,7 @@ class TestResult:
         }
     )
 
+    # Name of the method representing the test, if applicable
     method: Optional[str] = field(
         default=None,
         metadata={
@@ -73,6 +90,7 @@ class TestResult:
         }
     )
 
+    # Name of the module containing the test, if applicable
     module: Optional[str] = field(
         default=None,
         metadata={
@@ -80,6 +98,7 @@ class TestResult:
         }
     )
 
+    # Path to the file containing the test, if applicable
     file_path: Optional[str] = field(
         default=None,
         metadata={
@@ -87,6 +106,7 @@ class TestResult:
         }
     )
 
+    # Docstring of the test, if applicable
     doc_string: Optional[str] = field(
         default=None,
         metadata={

orionis/test/enums/__init__.py

@@ -1,7 +1,5 @@
-from .execution_mode import ExecutionMode
 from .status import TestStatus
 
 __all__ = [
-    "ExecutionMode",
     "TestStatus"
 ]

orionis/test/enums/status.py

@@ -3,20 +3,25 @@ from enum import Enum, auto
 class TestStatus(Enum):
     """
     TestStatus(Enum)
-    Enum representing the possible statuses of a test.
+    An enumeration representing the possible statuses that a test can have during its execution.
 
     Attributes
     ----------
     PASSED : auto()
-        Indicates that the test was executed successfully without any issues.
+        The test completed successfully without any errors or failures.
     FAILED : auto()
-        Indicates that the test was executed but did not meet the expected outcome.
+        The test ran to completion but did not produce the expected results.
     ERRORED : auto()
-        Indicates that an error occurred during the execution of the test.
+        An unexpected error occurred during the execution of the test, preventing it from completing.
     SKIPPED : auto()
-        Indicates that the test was intentionally skipped and not executed.
+        The test was intentionally not executed, typically due to configuration or conditional logic.
+
+    Returns
+    -------
+    TestStatus
+        An instance of the TestStatus enumeration indicating the current status of a test.
     """
-    PASSED = auto()
-    FAILED = auto()
-    ERRORED = auto()
-    SKIPPED = auto()
+    PASSED = auto()   # Test executed successfully
+    FAILED = auto()   # Test executed but failed
+    ERRORED = auto()  # Error occurred during test execution
+    SKIPPED = auto()  # Test was intentionally skipped

orionis/test/exceptions/config.py

@@ -2,18 +2,26 @@ class OrionisTestConfigException(Exception):
 
     def __init__(self, msg: str):
         """
+        Initializes the OrionisTestConfigException with a descriptive error message.
+
         Parameters
         ----------
         msg : str
             Descriptive error message explaining the cause of the exception.
         """
+
+        # Call the base Exception class constructor with the message
         super().__init__(msg)
 
     def __str__(self) -> str:
         """
+        Returns a formatted string representation of the exception message.
+
         Returns
         -------
         str
-            Formatted string describing the exception.
+            The error message provided during exception initialization.
         """
+
+        # Return the first argument as the exception message
         return str(self.args[0])

orionis/test/exceptions/failure.py

@@ -4,7 +4,11 @@ class OrionisTestFailureException(Exception):
 
     def __init__(self, result: unittest.TestResult):
         """
-        Initialize the exception with details about failed and errored tests.
+        Initializes the OrionisTestFailureException with details about failed and errored tests.
+
+        This constructor extracts information from the provided unittest.TestResult object,
+        including the IDs of tests that failed or encountered errors. It then formats a summary
+        message listing all such tests and passes this message to the base Exception class.
 
         Parameters
         ----------
@@ -13,38 +17,57 @@ class OrionisTestFailureException(Exception):
 
         Attributes
         ----------
-        failed_tests : list
-            List of IDs for tests that failed.
-        errored_tests : list
-            List of IDs for tests that encountered errors.
-        error_messages : list
-            List of formatted error messages for failed and errored tests.
+        failed_tests : list of str
+            List of test IDs that failed.
+        errored_tests : list of str
+            List of test IDs that encountered errors.
+        error_messages : list of str
+            List of formatted error messages for each failed or errored test.
         text : str
-            Formatted string summarizing the test failures and errors.
+            Formatted string summarizing all test failures and errors.
+
+        Returns
+        -------
+        None
+            This method does not return a value. It initializes the exception instance.
 
         Raises
         ------
-        Exception
-            If there are failed or errored tests, raises an exception with a summary message.
+        OrionisTestFailureException
+            Raised when there are failed or errored tests, with a summary message.
         """
+
+        # Collect IDs of failed tests
         failed_tests = [test.id() for test, _ in result.failures]
+
+        # Collect IDs of tests that encountered errors
         errored_tests = [test.id() for test, _ in result.errors]
 
         error_messages = []
+
+        # Add formatted messages for failed tests
         for test in failed_tests:
             error_messages.append(f"Test Fail: {test}")
+
+        # Add formatted messages for errored tests
         for test in errored_tests:
             error_messages.append(f"Test Error: {test}")
 
+        # Combine all error messages into a single string
         text = "\n".join(error_messages)
 
+        # Initialize the base Exception with the summary message
         super().__init__(f"{len(failed_tests) + len(errored_tests)} test(s) failed or errored:\n{text}")
 
     def __str__(self) -> str:
         """
+        Returns a formatted string describing the exception.
+
         Returns
         -------
         str
-            Formatted string describing the exception.
+            The summary message containing the number and details of failed and errored tests.
         """
+
+        # Return the first argument passed to the exception as a string
         return str(self.args[0])

orionis/test/exceptions/persistence.py

@@ -2,18 +2,26 @@ class OrionisTestPersistenceError(Exception):
 
     def __init__(self, msg: str):
         """
+        Initializes the OrionisTestPersistenceError with a descriptive error message.
+
         Parameters
         ----------
         msg : str
-            Descriptive error message explaining the cause of the exception.
+            A descriptive error message that explains the cause of the exception.
         """
+
+        # Call the base Exception class constructor with the message
         super().__init__(msg)
 
     def __str__(self) -> str:
         """
+        Returns a formatted string representation of the exception message.
+
         Returns
         -------
         str
-            Formatted string describing the exception.
+            The error message provided when the exception was raised.
         """
+
+        # Return the first argument passed to the exception as a string
         return str(self.args[0])

orionis/test/exceptions/runtime.py

@@ -2,18 +2,26 @@ class OrionisTestRuntimeError(Exception):
 
     def __init__(self, msg: str):
         """
+        Initializes the OrionisTestRuntimeError with a descriptive error message.
+
         Parameters
         ----------
         msg : str
             Descriptive error message explaining the cause of the exception.
         """
+
+        # Call the base class constructor with the error message
         super().__init__(msg)
 
     def __str__(self) -> str:
         """
+        Returns a formatted string representation of the exception.
+
         Returns
         -------
         str
-            Formatted string describing the exception.
+            The error message provided during exception initialization.
         """
+
+        # Return the error message stored in the first argument
         return str(self.args[0])

orionis/test/exceptions/value.py

@@ -2,18 +2,30 @@ class OrionisTestValueError(Exception):
 
     def __init__(self, msg: str):
         """
+        Initializes the OrionisTestValueError with a descriptive error message.
+
         Parameters
         ----------
         msg : str
             Descriptive error message explaining the cause of the exception.
         """
+
+        # Call the base class constructor with the error message
         super().__init__(msg)
 
     def __str__(self) -> str:
         """
+        Returns a formatted string representation of the exception.
+
+        This method retrieves the error message provided during initialization
+        and returns it as a string. It ensures that when the exception is
+        converted to a string, the descriptive message is displayed.
+
         Returns
         -------
         str
-            Formatted string describing the exception.
+            The descriptive error message associated with this exception.
         """
+
+        # Return the error message stored in the first argument
         return str(self.args[0])