orionis 0.431.0__py3-none-any.whl → 0.434.0__py3-none-any.whl

orionis/test/validators/execution_mode.py

@@ -5,8 +5,7 @@ class __ValidExecutionMode:
 
     def __call__(self, execution_mode: str | ExecutionMode) -> str:
         """
-        Validates that the provided execution_mode is either a valid string representation
-        of an ExecutionMode enum member or an instance of the ExecutionMode enum.
+        Validate and normalize an execution mode value.
 
         Parameters
         ----------
@@ -22,7 +21,7 @@ class __ValidExecutionMode:
         Raises
         ------
         OrionisTestValueError
-            If execution_mode is not a string or ExecutionMode enum, or if the string
+            If `execution_mode` is not a string or ExecutionMode enum, or if the string
             does not correspond to a valid ExecutionMode member.
         """
 

orionis/test/validators/fail_fast.py

@@ -4,21 +4,17 @@ class __ValidFailFast:
 
     def __call__(self, fail_fast) -> bool:
         """
-        Validator that ensures the `fail_fast` parameter is a boolean.
-
-        This class is intended to be used as a callable validator to check that the
-        provided `fail_fast` argument is of type `bool`. If the value is not a boolean,
-        an `OrionisTestValueError` is raised with a descriptive error message.
+        Validates that the `fail_fast` parameter is a boolean.
 
         Parameters
         ----------
         fail_fast : Any
-            The value to be validated as a boolean.
+            The value to validate as a boolean.
 
         Returns
         -------
         bool
-            The validated boolean value of `fail_fast`.
+            The validated boolean value.
 
         Raises
         ------
@@ -34,4 +30,4 @@ class __ValidFailFast:
         return fail_fast
 
 # Exported singleton instance
-ValidFailFast = __ValidFailFast()
+ValidFailFast = __ValidFailFast()

orionis/test/validators/folder_path.py

@@ -1,28 +1,26 @@
-from pathlib import Path
 from orionis.test.exceptions import OrionisTestValueError
 
 class __ValidFolderPath:
 
     def __call__(self, folder_path: str) -> str:
         """
-        Validate and clean a folder path string.
+        Validates that the input is a non-empty string representing a folder path.
 
         Parameters
         ----------
         folder_path : str
-            The folder path to validate.
+            The folder path to be validated.
 
         Returns
         -------
         str
-            The cleaned folder path string.
+            The validated and stripped folder path.
 
         Raises
         ------
         OrionisTestValueError
-            If the folder_path is not a non-empty string.
+            If `folder_path` is not a non-empty string.
         """
-
         if not isinstance(folder_path, str) or not folder_path.strip():
             raise OrionisTestValueError(
                 f"Invalid folder_path: Expected a non-empty string, got '{str(folder_path)}' ({type(folder_path).__name__})."
@@ -31,4 +29,4 @@ class __ValidFolderPath:
         return folder_path.strip()
 
 # Exported singleton instance
-ValidFolderPath = __ValidFolderPath()
+ValidFolderPath = __ValidFolderPath()

orionis/test/validators/module_name.py

@@ -4,12 +4,12 @@ class __ValidModuleName:
 
     def __call__(self, module_name) -> str:
         """
-        Validator that ensures the `module_name` parameter is a non-empty string.
+        Validates that the input is a non-empty string.
 
         Parameters
         ----------
         module_name : Any
-            The value to be validated as a non-empty string.
+            The value to validate as a non-empty string.
 
         Returns
         -------
@@ -28,4 +28,4 @@ class __ValidModuleName:
         return module_name
 
 # Exported singleton instance
-ValidModuleName = __ValidModuleName()
+ValidModuleName = __ValidModuleName()

orionis/test/validators/name_pattern.py

@@ -4,28 +4,23 @@ class __ValidNamePattern:
 
     def __call__(self, test_name_pattern) -> str:
         """
-        Validator that ensures the `test_name_pattern` parameter is a non-empty string.
-
-        This class is intended to be used as a callable validator to check that the
-        provided `test_name_pattern` argument is a non-empty string. If the value is not a valid
-        string, an `OrionisTestValueError` is raised with a descriptive error message.
+        Validates that the input is a non-empty string.
 
         Parameters
         ----------
         test_name_pattern : Any
-            The value to be validated as a non-empty string.
+            The value to validate as a non-empty string.
 
         Returns
         -------
         str
-            The validated and stripped string value of `test_name_pattern`.
+            The validated and stripped string if valid, otherwise returns the original value if None.
 
         Raises
         ------
         OrionisTestValueError
             If `test_name_pattern` is not a non-empty string.
         """
-
         if test_name_pattern is not None:
 
             if not isinstance(test_name_pattern, str) or not test_name_pattern.strip():
@@ -37,4 +32,4 @@ class __ValidNamePattern:
         return test_name_pattern
 
 # Exported singleton instance
-ValidNamePattern = __ValidNamePattern()
+ValidNamePattern = __ValidNamePattern()

orionis/test/validators/pattern.py

@@ -4,28 +4,23 @@ class __ValidPattern:
 
     def __call__(self, pattern) -> str:
         """
-        Validator that ensures the `pattern` parameter is a non-empty string.
-
-        This class is intended to be used as a callable validator to check that the
-        provided `pattern` argument is a non-empty string. If the value is not a valid
-        string, an `OrionisTestValueError` is raised with a descriptive error message.
+        Validates that the input is a non-empty string.
 
         Parameters
         ----------
         pattern : Any
-            The value to be validated as a non-empty string.
+            The value to validate as a non-empty string.
 
         Returns
         -------
         str
-            The validated and stripped string value of `pattern`.
+            The validated and stripped string.
 
         Raises
         ------
         OrionisTestValueError
             If `pattern` is not a non-empty string.
         """
-
         if not isinstance(pattern, str) or not pattern.strip():
             raise OrionisTestValueError(
                 f"Invalid pattern: Expected a non-empty string, got '{str(pattern)}' ({type(pattern).__name__})."
@@ -33,4 +28,4 @@ class __ValidPattern:
         return pattern.strip()
 
 # Exported singleton instance
-ValidPattern = __ValidPattern()
+ValidPattern = __ValidPattern()

orionis/test/validators/persistent.py

@@ -4,33 +4,23 @@ class __ValidPersistent:
 
     def __call__(self, persistent) -> bool:
         """
-        Validator that ensures the `persistent` parameter is a boolean.
-
-        This class is intended to be used as a callable validator to check if the
-        provided value for `persistent` is of type `bool`. If the value is not a
-        boolean, an `OrionisTestValueError` is raised.
-
-        Methods
-        -------
-        __call__(persistent) -> bool
-            Validates that `persistent` is a boolean.
+        Validates that the input is a boolean value.
 
         Parameters
         ----------
         persistent : Any
-            The value to be validated as a boolean.
+            The value to validate as a boolean.
 
         Returns
         -------
         bool
-            Returns the value of `persistent` if it is a boolean.
+            The input value if it is a boolean.
 
         Raises
         ------
         OrionisTestValueError
-            If `persistent` is not a boolean.
+            If the input is not a boolean.
         """
-
         if not isinstance(persistent, bool):
             raise OrionisTestValueError(
                 f"Invalid persistent: Expected a boolean, got '{persistent}' ({type(persistent).__name__})."

orionis/test/validators/persistent_driver.py

@@ -5,28 +5,23 @@ class __ValidPersistentDriver:
 
     def __call__(self, persistent_driver) -> str:
         """
-        Validator class for persistent driver types.
-        This class is intended to validate the value of a persistent driver, ensuring
-        that it is a string or PersistentDrivers enum and one of the accepted values.
-        Methods
-        -------
-        __call__(persistent_driver: str | PersistentDrivers) -> str
-            Validates the given persistent driver. Raises an OrionisTestValueError if
-            the input is not a string or enum or not one of the accepted values.
+        Validates the provided persistent driver value.
+
         Parameters
         ----------
-        persistent_driver : str | PersistentDrivers
-            The persistent driver to validate. Must be either 'sqlite', 'json', or the corresponding enum.
+        persistent_driver : str or PersistentDrivers
+            The persistent driver to validate. Must be either a string or a member of the PersistentDrivers enum.
+
         Returns
         -------
         str
             The validated persistent driver as a string.
+
         Raises
         ------
         OrionisTestValueError
-            If the input is not a string/enum or not one of the accepted values.
+            If the input is not a string or PersistentDrivers enum, or if it is not one of the accepted values.
         """
-
         if not isinstance(persistent_driver, (str, PersistentDrivers)):
             raise OrionisTestValueError(
             f"Invalid type for persistent_driver: Expected str or PersistentDrivers, got {type(persistent_driver).__name__}."

orionis/test/validators/print_result.py

@@ -4,28 +4,23 @@ class __ValidPrintResult:
 
     def __call__(self, print_result) -> bool:
         """
-        Validator that ensures the `print_result` parameter is a boolean.
-
-        This class is intended to be used as a callable validator to check that the
-        provided `print_result` argument is of type `bool`. If the validation fails,
-        an `OrionisTestValueError` is raised.
+        Validates that the `print_result` parameter is a boolean.
 
         Parameters
         ----------
         print_result : Any
-            The value to be validated as a boolean.
+            The value to validate as a boolean.
 
         Returns
         -------
         bool
-            Returns the validated boolean value of `print_result`.
+            The validated boolean value of `print_result`.
 
         Raises
         ------
         OrionisTestValueError
             If `print_result` is not of type `bool`.
         """
-
         if not isinstance(print_result, bool):
             raise OrionisTestValueError(
                 f"Invalid print_result: Expected a boolean, got '{print_result}' ({type(print_result).__name__})."
@@ -34,4 +29,4 @@ class __ValidPrintResult:
         return print_result
 
 # Exported singleton instance
-ValidPrintResult = __ValidPrintResult()
+ValidPrintResult = __ValidPrintResult()

orionis/test/validators/tags.py

@@ -4,24 +4,23 @@ class __ValidTags:
 
     def __call__(self, tags):
         """
-        Validator that ensures the `tags` parameter is a non-empty list of non-empty strings.
+        Validates that the input is a non-empty list of non-empty strings.
 
         Parameters
         ----------
         tags : Any
-            The value to be validated as a list of non-empty strings.
+            The value to validate as a list of non-empty strings.
 
         Returns
         -------
-        list
-            The validated and stripped list of tags.
+        list or None
+            The validated and stripped list of tags if valid, otherwise None if input is None.
 
         Raises
         ------
         OrionisTestValueError
-            If `tags` is not a non-empty list of non-empty strings.
+            If the input is not a non-empty list of non-empty strings.
         """
-
         if tags is not None:
 
             if (not isinstance(tags, list) or not tags or not all(isinstance(tag, str) and tag.strip() for tag in tags)):
@@ -34,4 +33,4 @@ class __ValidTags:
         return None
 
 # Exported singleton instance
-ValidTags = __ValidTags()
+ValidTags = __ValidTags()

orionis/test/validators/throw_exception.py

@@ -4,30 +4,23 @@ class __ValidThrowException:
 
     def __call__(self, throw_exception) -> bool:
         """
-        __ValidThrowException is a validator class that ensures the `throw_exception` parameter is a boolean.
-
-        Methods
-        -------
-        __call__(throw_exception) -> bool
-            Validates that the input `throw_exception` is of type `bool`. If not, raises an OrionisTestValueError
-            with a descriptive message. Returns the validated boolean value.
+        Validates that the input is a boolean.
 
         Parameters
         ----------
         throw_exception : Any
-            The value to be validated as a boolean.
+            The value to validate as a boolean.
+
+        Returns
+        -------
+        bool
+            The validated boolean value.
 
         Raises
         ------
         OrionisTestValueError
             If `throw_exception` is not a boolean.
-
-        Returns
-        -------
-        bool
-            The validated boolean value of `throw_exception`.
         """
-
         if not isinstance(throw_exception, bool):
             raise OrionisTestValueError(
                 f"Invalid throw_exception: Expected a boolean, got '{throw_exception}' ({type(throw_exception).__name__})."

orionis/test/validators/verbosity.py

@@ -3,22 +3,32 @@ from orionis.test.exceptions import OrionisTestValueError
 
 class __ValidVerbosity:
     """
-    Validator that ensures the verbosity level is a non-negative integer or a valid VerbosityMode.
+    Validator for verbosity levels, ensuring the input is a non-negative integer corresponding to a valid
+    VerbosityMode value or an instance of VerbosityMode.
+
+    This class is intended to validate verbosity arguments for test configuration.
     """
 
     def __call__(self, verbosity) -> int:
         """
-        Ensures that the provided verbosity is a non-negative integer or a valid VerbosityMode.
+        Validate the verbosity level.
 
         Parameters
         ----------
         verbosity : int or VerbosityMode
-            The verbosity level to validate.
+            The verbosity level to validate. Must be a non-negative integer matching a VerbosityMode value,
+            or an instance of VerbosityMode.
+
+        Returns
+        -------
+        int
+            The validated verbosity level as an integer.
 
         Raises
         ------
         OrionisTestValueError
-            If the verbosity is not a non-negative integer or a valid VerbosityMode.
+            If the verbosity is not a non-negative integer corresponding to a VerbosityMode value,
+            nor an instance of VerbosityMode.
         """
         if isinstance(verbosity, VerbosityMode):
             return verbosity.value
@@ -34,4 +44,4 @@ class __ValidVerbosity:
         )
 
 # Exported singleton instance
-ValidVerbosity = __ValidVerbosity()
+ValidVerbosity = __ValidVerbosity()

orionis/test/validators/web_report.py

@@ -1,29 +1,25 @@
 from orionis.test.exceptions import OrionisTestValueError
 
 class __ValidWebReport:
-
     def __call__(self, web_report) -> bool:
         """
-        Validator class to check if the input is a boolean value.
-        This class is intended to be used as a callable to validate whether the provided
-        `web_report` argument is of type `bool`. If the input is not a boolean, an
-        `OrionisTestValueError` is raised with a descriptive error message.
+        Validates that the input is a boolean value.
 
         Parameters
         ----------
-        None
+        web_report : Any
+            The value to be validated as a boolean.
 
-        Methods
+        Returns
         -------
-        __call__(web_report)
-            Validates that `web_report` is a boolean value.
+        bool
+            The validated boolean value.
 
         Raises
         ------
         OrionisTestValueError
             If `web_report` is not of type `bool`.
         """
-
         if not isinstance(web_report, bool):
             raise OrionisTestValueError(
                 f"Invalid web_report: Expected a boolean, got '{web_report}' ({type(web_report).__name__})."

orionis/test/validators/workers.py

@@ -3,22 +3,27 @@ from orionis.test.exceptions import OrionisTestValueError
 
 class __ValidWorkers:
     """
-    Validator that ensures max_workers is a positive integer within allowed range.
+    Validator for the `max_workers` parameter, ensuring it is a positive integer within the allowed range.
     """
 
     def __call__(self, max_workers: int) -> int:
         """
-        Ensures that the provided max_workers is a positive integer within allowed range.
+        Validate the `max_workers` argument.
 
         Parameters
         ----------
         max_workers : int
-            The max_workers value to validate.
+            The number of worker processes or threads to validate.
+
+        Returns
+        -------
+        int
+            The validated `max_workers` value.
 
         Raises
         ------
         OrionisTestValueError
-            If max_workers is not a positive integer within allowed range.
+            If `max_workers` is not a positive integer within the allowed range.
         """
         max_allowed = Workers.calculate()
         if not isinstance(max_workers, int) or max_workers < 1 or max_workers > max_allowed:

orionis/test/view/render.py

@@ -13,28 +13,20 @@ class TestingResultRender(ITestingResultRender):
         persist: bool = False
     ) -> None:
         """
-        Initialize a TestingResultRender instance for rendering test results.
-
-        This constructor sets up the renderer with the provided test result data,
-        determines the storage location for the generated report, and configures
-        whether persistent storage (e.g., SQLite) should be used for storing and
-        retrieving test reports.
+        Initializes the TestingResultRender instance.
 
         Parameters
         ----------
         result : Any
-            The test result data to be rendered and included in the report.
+            The test result data to be rendered in the report.
         storage_path : str
-            The directory path where the HTML report will be saved. If the directory
-            does not exist, it will be created automatically.
+            Directory path where the HTML report will be saved. The directory is created if it does not exist.
         persist : bool, optional
             If True, enables persistent storage for test reports (default is False).
 
         Returns
         -------
         None
-            This constructor does not return a value. It initializes internal state
-            and prepares the report path for future rendering.
         """
         self.__filename = 'orionis-test-results.html'
         self.__result = result
@@ -52,27 +44,18 @@ class TestingResultRender(ITestingResultRender):
         self
     ) -> str:
         """
-        Otherwise, uses the current test result stored in memory. The method replaces placeholders in a
-        template file with the test results and the persistence mode, then writes the rendered content
-        to a report file.
+        Renders the test results into an HTML report file.
 
-        Parameters
-        ----------
-        None
+        If persistence is enabled, retrieves the last 10 reports from the database and includes them in the report.
+        Otherwise, only the current in-memory test result is used. The method reads a template file, replaces
+        placeholders with the test results and persistence mode, writes the rendered content to a report file,
+        and attempts to open the report in the default web browser on supported platforms.
 
         Returns
         -------
         str
-            The full path to the generated report file.
-
-        Notes
-        -----
-        - If persistence is enabled, the last 10 reports are fetched from the SQLite database.
-        - If persistence is not enabled, only the current test result in memory is used.
-        - The method reads a template file, replaces placeholders with the test results and persistence mode,
-          and writes the final content to the report file.
+            The absolute path to the generated HTML report file.
         """
-
         # Determine the source of test results based on persistence mode
         if self.__persist:
 

{orionis-0.431.0.dist-info → orionis-0.434.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orionis
-Version: 0.431.0
+Version: 0.434.0
 Summary: Orionis Framework – Elegant, Fast, and Powerful.
 Home-page: https://github.com/orionis-framework/framework
 Author: Raul Mauricio Uñate Castro