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

orionis/foundation/providers/console_provider.py

@@ -3,15 +3,37 @@ from orionis.console.output.contracts.console import IConsole
 from orionis.container.providers.service_provider import ServiceProvider
 
 class ConsoleProvider(ServiceProvider):
+    """
+    ConsoleProvider
+    ===============
+
+    Registers the console output service in the application container.
+    Provides access to various console output features, including information, warnings, errors, debug messages, tables, confirmations, and password prompts.
+
+    Methods
+    -------
+    register()
+        Registers the console service in the application container.
+    boot()
+        Performs post-registration initialization if needed.
+    """
 
     def register(self) -> None:
         """
-        Register services into the application container.
+        Registers the console service in the application container.
+
+        Returns
+        -------
+        None
         """
         self.app.transient(IConsole, Console, alias="core.orionis.console")
 
     def boot(self) -> None:
         """
-        Perform any post-registration bootstrapping or initialization.
+        Performs post-registration initialization if needed.
+
+        Returns
+        -------
+        None
         """
         pass

orionis/foundation/providers/dumper_provider.py

@@ -3,15 +3,37 @@ from orionis.console.dumper.contracts.dump import IDebug
 from orionis.container.providers.service_provider import ServiceProvider
 
 class DumperProvider(ServiceProvider):
+    """
+    DumperProvider
+    ==============
+
+    Registers the debug message service in the application container.
+    Provides access to debug message printing, error reporting, and other console diagnostics.
+
+    Methods
+    -------
+    register()
+        Registers the debug service in the application container.
+    boot()
+        Performs post-registration initialization if needed.
+    """
 
     def register(self) -> None:
         """
-        Register services into the application container.
+        Registers the debug service in the application container.
+
+        Returns
+        -------
+        None
         """
         self.app.transient(IDebug, Debug, alias="core.orionis.dumper")
 
     def boot(self) -> None:
         """
-        Perform any post-registration bootstrapping or initialization.
+        Performs post-registration initialization if needed.
+
+        Returns
+        -------
+        None
         """
         pass

orionis/foundation/providers/logger_provider.py

@@ -3,15 +3,37 @@ from orionis.services.log.contracts.log_service import ILoggerService
 from orionis.services.log.log_service import LoggerService
 
 class LoggerProvider(ServiceProvider):
+    """
+    LoggerProvider
+    ==============
+
+    Registers the logging service in the application container.
+    Provides a `LoggerService` instance for application-wide logging.
+
+    Methods
+    -------
+    register()
+        Registers the logging service in the application container.
+    boot()
+        Performs post-registration initialization if needed.
+    """
 
     def register(self) -> None:
         """
-        Register services into the application container.
+        Registers the logging service in the application container.
+
+        Returns
+        -------
+        None
         """
         self.app.instance(ILoggerService, LoggerService(self.app.config('logging')), alias="core.orionis.logger")
 
     def boot(self) -> None:
         """
-        Perform any post-registration bootstrapping or initialization.
+        Performs post-registration initialization if needed.
+
+        Returns
+        -------
+        None
         """
         pass

orionis/foundation/providers/path_resolver_provider.py

@@ -3,15 +3,38 @@ from orionis.services.paths.contracts.resolver import IResolver
 from orionis.services.paths.resolver import Resolver
 
 class PathResolverProvider(ServiceProvider):
+    """
+    PathResolverProvider
+    ===================
+
+    Registers the path resolution service in the application container.
+    Provides compatibility with the file system for resolving paths.
+
+    Methods
+    -------
+    register()
+        Registers the path resolver service in the application container.
+    boot()
+        Performs post-registration initialization if needed.
+    """
+
 
     def register(self) -> None:
         """
-        Register services into the application container.
+        Registers the path resolver service in the application container.
+
+        Returns
+        -------
+        None
         """
         self.app.transient(IResolver, Resolver, alias="core.orionis.path_resolver")
 
     def boot(self) -> None:
         """
-        Perform any post-registration bootstrapping or initialization.
+        Performs post-registration initialization if needed.
+
+        Returns
+        -------
+        None
         """
         pass

orionis/foundation/providers/progress_bar_provider.py

@@ -3,15 +3,37 @@ from orionis.console.dynamic.progress_bar import ProgressBar
 from orionis.container.providers.service_provider import ServiceProvider
 
 class ProgressBarProvider(ServiceProvider):
+    """
+    ProgressBarProvider
+    ===================
+
+    Registers the dynamic progress bar service in the application container.
+    Provides a console progress bar for visual feedback during operations.
+
+    Methods
+    -------
+    register()
+        Registers the progress bar service in the application container.
+    boot()
+        Performs post-registration initialization if needed.
+    """
 
     def register(self) -> None:
         """
-        Register services into the application container.
+        Registers the progress bar service in the application container.
+
+        Returns
+        -------
+        None
         """
         self.app.transient(IProgressBar, ProgressBar, alias="core.orionis.progress_bar")
 
     def boot(self) -> None:
         """
-        Perform any post-registration bootstrapping or initialization.
+        Performs post-registration initialization if needed.
+
+        Returns
+        -------
+        None
         """
         pass

orionis/foundation/providers/testing_provider.py

@@ -0,0 +1,39 @@
+from orionis.container.providers.service_provider import ServiceProvider
+from orionis.test.contracts.unit_test import IUnitTest
+from orionis.test.core.unit_test import UnitTest
+
+class TestingProvider(ServiceProvider):
+    """
+    TestingProvider
+    ===============
+
+    Registers the unit testing environment service in the application container.
+    Provides a native unit testing framework for Orionis with features beyond common frameworks.
+
+    Methods
+    -------
+    register()
+        Registers the unit testing service in the application container.
+    boot()
+        Performs post-registration initialization if needed.
+    """
+
+    def register(self) -> None:
+        """
+        Registers the unit testing service in the application container.
+
+        Returns
+        -------
+        None
+        """
+        self.app.singleton(IUnitTest, UnitTest, alias="core.orionis.testing")
+
+    def boot(self) -> None:
+        """
+        Performs post-registration initialization if needed.
+
+        Returns
+        -------
+        None
+        """
+        pass

orionis/foundation/providers/workers_provider.py

@@ -3,15 +3,37 @@ from orionis.services.system.contracts.workers import IWorkers
 from orionis.services.system.workers import Workers
 
 class WorkersProvider(ServiceProvider):
+    """
+    WorkersProvider
+    ===============
+
+    Registers the worker management service in the application container.
+    Determines the optimal number of workers to start based on system analysis.
+
+    Methods
+    -------
+    register()
+        Registers the worker service in the application container.
+    boot()
+        Performs post-registration initialization if needed.
+    """
 
     def register(self) -> None:
         """
-        Register services into the application container.
+        Registers the worker service in the application container.
+
+        Returns
+        -------
+        None
         """
         self.app.transient(IWorkers, Workers, alias="core.orionis.workers")
 
     def boot(self) -> None:
         """
-        Perform any post-registration bootstrapping or initialization.
+        Performs post-registration initialization if needed.
+
+        Returns
+        -------
+        None
         """
         pass

orionis/metadata/framework.py

@@ -5,7 +5,7 @@
 NAME = "orionis"
 
 # Current version of the framework
-VERSION = "0.405.0"
+VERSION = "0.406.0"
 
 # Full name of the author or maintainer of the project
 AUTHOR = "Raul Mauricio Uñate Castro"

orionis/services/environment/helpers/functions.py

@@ -17,5 +17,4 @@ def env(key: str, default: Any = None) -> Any:
     Any
         The value of the environment variable if it exists, otherwise the default value.
     """
-    dotenv = DotEnv()
-    return dotenv.get(key, default)
+    return DotEnv().get(key, default)

orionis/services/environment/key/key_generator.py

@@ -0,0 +1,37 @@
+import os
+import base64
+
+class SecureKeyGenerator:
+    """
+    Provides static methods for generating secure random keys in base64 format.
+
+    Methods
+    -------
+    generate_key() : str
+        Generates a secure random key encoded in base64.
+    """
+
+    @staticmethod
+    def generate() -> str:
+        """
+        Generates a secure random key and encodes it in base64 format.
+
+        This method creates a cryptographically secure random key of 32 bytes,
+        encodes it using base64 encoding, and returns the result as a string
+        prefixed with 'base64:'.
+
+        Returns
+        -------
+        str
+            A string in the format 'base64:<key>', where <key> is a base64-encoded
+            representation of a securely generated 32-byte random key.
+        """
+
+        # Generate 32 bytes of cryptographically secure random data
+        key = os.urandom(32)
+
+        # Encode the random bytes using base64 and decode to a UTF-8 string
+        encoded = base64.b64encode(key).decode('utf-8')
+
+        # Return the key in the required format
+        return f"base64:{encoded}"

orionis/support/entities/base.py

@@ -0,0 +1,104 @@
+from dataclasses import asdict, fields, is_dataclass, MISSING
+from enum import Enum
+
+class BaseEntity:
+
+    def toDict(self) -> dict:
+        """
+        Converts the current instance into a dictionary representation.
+
+        Returns
+        -------
+        dict
+            Dictionary representation of the current instance.
+        """
+        return asdict(self)
+
+    def getFields(self):
+        """
+        Retrieves a list of field information for the current dataclass instance.
+
+        Returns
+        -------
+        list
+            A list of dictionaries, each containing details about a field:
+            - name (str): The name of the field.
+            - type (type): The type of the field.
+            - default: The default value of the field, if specified; otherwise, the value from metadata or None.
+            - metadata (mapping): The metadata associated with the field.
+        """
+        # Dictionary to hold field information
+        __fields = []
+
+        # Iterate over the fields of the dataclass and extract relevant information
+        for field in fields(self):
+
+            # Get the field name
+            __name = field.name
+
+            # Get the field type with better handling for complex types
+            __type = getattr(field.type, '__name__', None)
+
+            # If the type is None, handle it
+            if __type is None:
+
+                # Handle Union types or other complex types
+                type_lst = []
+                type_str = str(field.type).split('|')
+                for itype in type_str:
+                    type_lst.append(itype.strip())
+                __type = type_lst
+
+            # Ensure __type is a list for consistency
+            __type = type_lst if isinstance(__type, list) else [__type]
+
+            # Extract metadata, default value, and type
+            metadata = dict(field.metadata) if field.metadata else {}
+
+            # If metadata contains a default value, normalize it
+            if 'default' in metadata:
+                metadata_default = metadata['default']
+                if callable(metadata_default):
+                    metadata_default = metadata_default()
+                if is_dataclass(metadata_default):
+                    metadata_default = asdict(metadata_default)
+                elif isinstance(metadata_default, Enum):
+                    metadata_default = metadata_default.value
+                metadata['default'] = metadata_default
+
+            # Add the field information to the list
+            __metadata = metadata
+
+            # Extract the default value, if specified
+            __default = None
+
+            # Field has a direct default value
+            if field.default is not MISSING:
+                __default = field.default() if callable(field.default) else field.default
+                if is_dataclass(__default):
+                    __default = asdict(__default)
+                elif isinstance(__default, Enum):
+                    __default = __default.value
+
+            # Field has a default factory (like list, dict, etc.)
+            elif field.default_factory is not MISSING:
+                __default = field.default_factory() if callable(field.default_factory) else field.default_factory
+                if is_dataclass(__default):
+                    __default = asdict(__default)
+                elif isinstance(__default, Enum):
+                    __default = __default.value
+
+            # No default found, check metadata for custom default
+            else:
+                __default = __metadata.get('default', None)
+
+            # Append the field information to the list
+            __fields.append({
+                "name": __name,
+                "types": __type,
+                "default": __default,
+                "metadata": __metadata
+            })
+
+        # Return the list of field information
+        return __fields

orionis/support/facades/testing.py

@@ -0,0 +1,15 @@
+from orionis.container.facades.facade import Facade
+
+class Test(Facade):
+
+    @classmethod
+    def getFacadeAccessor(cls) -> str:
+        """
+        Get the service container binding key for the dumper component.
+
+        Returns
+        -------
+        str
+            The service container binding key.
+        """
+        return "core.orionis.testing"

orionis/support/facades/workers.py

@@ -1,6 +1,6 @@
 from orionis.container.facades.facade import Facade
 
-class ProgressBar(Facade):
+class Workers(Facade):
 
     @classmethod
     def getFacadeAccessor(cls):

orionis/test/cases/asynchronous.py

@@ -30,17 +30,6 @@ class AsyncTestCase(unittest.IsolatedAsyncioTestCase, TestDumper):
         Hook method for subclass-specific async setup logic.
     onAsyncTeardown()
         Hook method for subclass-specific async teardown logic.
-
-    Examples
-    --------
-    >>> class MyAsyncTest(AsyncTestCase):
-    ...     async def onAsyncSetup(self):
-    ...         self.client = AsyncHttpClient()
-    ...         await self.client.connect()
-    ...
-    ...     async def testAsyncOperation(self):
-    ...         result = await self.client.get('/api/data')
-    ...         self.assertEqual(result.status, 200)
     """
 
     async def asyncSetUp(self):

orionis/test/cases/synchronous.py

@@ -27,15 +27,6 @@ class SyncTestCase(unittest.TestCase, TestDumper):
         Hook method for subclass-specific setup logic.
     onTeardown()
         Hook method for subclass-specific teardown logic.
-
-    Examples
-    --------
-    >>> class MyTest(SyncTestCase):
-    ...     def onSetup(self):
-    ...         self.data = [1, 2, 3]
-    ...
-    ...     def testExample(self):
-    ...         self.assertEqual(len(self.data), 3)
     """
 
     def setUp(self):

orionis/test/contracts/dumper.py

@@ -17,15 +17,22 @@ class ITestDumper(ABC):
     @abstractmethod
     def dd(self, *args) -> None:
         """
-        Dumps debugging information using the Debug class.
+        Outputs debugging information using the Debug class.
 
-        This method captures the caller's file and line number,
-        and uses the Debug class to output debugging information.
+        This method captures the caller's file and line number, then
+        utilizes the Debug class to display or log the provided arguments
+        for debugging purposes.
 
         Parameters
         ----------
         *args : tuple
-            Variable length argument list to be dumped.
+            Variable length argument list containing the data to be dumped.
+
+        Returns
+        -------
+        None
+            This method does not return any value. Its purpose is to output
+            or log the debugging information.
         """
         pass
 

orionis/test/contracts/kernel.py

@@ -1,7 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import Any
-from orionis.foundation.config.testing.entities.testing import Testing as Configuration
-from orionis.test.core.unit_test import UnitTest
+from orionis.test.contracts.unit_test import IUnitTest
 
 class ITestKernel(ABC):
     """
@@ -19,116 +17,13 @@ class ITestKernel(ABC):
     """
 
     @abstractmethod
-    def handle(
-        self,
-        config: Configuration = None,
-        **kwargs: Any
-    ) -> UnitTest:
+    def handle(self) -> IUnitTest:
         """
-        Execute the complete test discovery and execution pipeline.
-
-        This is the main entry point for running tests. Implementations must:
-        1. Validate the provided configuration
-        2. Discover test files based on configuration
-        3. Configure and execute the test suite
-        4. Return the test results
-
-        Parameters
-        ----------
-        config : Configuration, optional
-            A pre-configured Testing configuration instance. If None,
-            implementations should create one from kwargs.
-        **kwargs : Any
-            Keyword arguments to create a Configuration instance if config is None.
-            Common parameters include:
-            - base_path : str, base directory for test discovery
-            - folder_path : str or list, specific folders to search
-            - pattern : str, file pattern for test discovery
-            - verbosity : int, output verbosity level
-            - execution_mode : str, test execution mode
-            - max_workers : int, maximum number of worker threads
-            - fail_fast : bool, stop on first failure
-
-        Returns
-        -------
-        UnitTest
-            The configured and executed test suite instance containing all results.
-
-        Raises
-        ------
-        OrionisTestConfigException
-            If the configuration validation fails.
-        """
-        pass
-
-    @abstractmethod
-    def handleCLI(
-        self,
-        sys_argv: list[str]
-    ) -> UnitTest:
-        """
-        Process command line arguments for test execution.
-
-        This method configures and runs tests based on command line arguments. It parses
-        the provided sys_argv list into a TestArguments object, extracts configuration
-        values, executes the tests, and handles output generation.
-
-        Parameters
-        ----------
-        sys_argv : list[str]
-            Command line arguments list including script name. The script name
-            (first element) will be automatically removed before parsing.
+        Configure and execute the unit tests based on the current configuration.
 
         Returns
         -------
-        UnitTest
-            The test suite instance containing all test results.
-
-        Raises
-        ------
-        OrionisTestConfigException
-            If the provided sys_argv is not a valid list or if argument parsing fails.
-
-        Notes
-        -----
-        The method supports various test execution options including parallel/sequential
-        execution mode, fail fast behavior, result output configuration, and web reporting.
+        IUnitTest
+            The configured and executed unit test instance.
         """
         pass
-
-    @abstractmethod
-    def exit(
-        self,
-        code: int = 0
-    ) -> None:
-        """
-        Terminate the test execution process and free associated resources.
-
-        This method performs a clean shutdown of the test kernel by explicitly
-        triggering garbage collection to release memory resources and then
-        terminating the process with the provided exit code. It ensures that any
-        remaining file handles, threads, or other resources are properly released.
-
-        Parameters
-        ----------
-        code : int
-            The exit code to return to the operating system. Should be 0 for
-            successful execution or a non-zero value to indicate an error.
-
-        Returns
-        -------
-        None
-            This method does not return as it terminates the process.
-
-        Raises
-        ------
-        ValueError
-            If the provided code is not a valid integer or outside the allowed range.
-
-        Notes
-        -----
-        Using os._exit() bypasses normal Python cleanup mechanisms and
-        immediately terminates the process. This can be necessary when
-        normal sys.exit() would be caught by exception handlers.
-        """
-        pass