orionis 0.413.0__tar.gz → 0.414.0__tar.gz

{orionis-0.413.0/orionis.egg-info → orionis-0.414.0}/PKG-INFO

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

{orionis-0.413.0 → orionis-0.414.0}/orionis/metadata/framework.py

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

orionis-0.414.0/orionis/support/entities/base.py

@@ -0,0 +1,123 @@
+from dataclasses import asdict, fields, is_dataclass, MISSING
+from enum import Enum
+
+class BaseEntity:
+
+    def toDict(self) -> dict:
+        """
+        Converts the current dataclass instance into a dictionary.
+
+        Parameters
+        ----------
+        None
+
+        Returns
+        -------
+        dict
+            A dictionary containing all fields of the instance, with field names as keys and their corresponding values.
+
+        Notes
+        -----
+        This method uses `dataclasses.asdict` to recursively convert the dataclass instance and any nested dataclasses into dictionaries.
+        Enum values are preserved as their actual values.
+        """
+
+        # Use asdict to convert the dataclass instance to a dictionary, including nested dataclasses
+        return asdict(self)
+
+    def getFields(self):
+        """
+        Retrieves detailed information about each field in the current dataclass instance.
+
+        Parameters
+        ----------
+        None
+
+        Returns
+        -------
+        list of dict
+            Each dictionary in the returned list contains:
+                - name (str): The name of the field.
+                - types (list of str): The type(s) of the field, represented as a list of type names.
+                - default: The default value of the field, resolved from the field definition, default factory, or metadata.
+                - metadata (dict): The metadata associated with the field.
+
+        Notes
+        -----
+        - Handles complex field types, including unions and generics, by representing them as lists of type names.
+        - Resolves default values from direct assignment, default factories, or metadata, and normalizes dataclass and Enum values.
+        - Metadata defaults are normalized if present and callable or dataclass/Enum types.
+        """
+
+        # List to hold field information dictionaries
+        __fields = []
+
+        # Iterate over all fields defined in the dataclass
+        for field in fields(self):
+
+            # Extract the field name
+            __name = field.name
+
+            # Attempt to get the type name; handles simple types
+            __type = getattr(field.type, '__name__', None)
+
+            # If type name is not available, handle complex types (e.g., Unions)
+            if __type is None:
+                type_lst = []
+                type_str = str(field.type).split('|')
+                for itype in type_str:
+                    type_lst.append(itype.strip())
+                __type = type_lst
+
+            # Ensure __type is always a list for consistency
+            __type = type_lst if isinstance(__type, list) else [__type]
+
+            # Extract metadata as a dictionary
+            metadata = dict(field.metadata) if field.metadata else {}
+
+            # Normalize default value in metadata if present
+            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
+
+            __metadata = metadata
+
+            # Initialize default value
+            __default = None
+
+            # Resolve default value from field definition
+            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
+
+            # Resolve default value from default factory if present
+            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
+
+            # If no default found, check metadata for custom default
+            else:
+                __default = __metadata.get('default', None)
+
+            # Append the field information dictionary to the list
+            __fields.append({
+                "name": __name,
+                "types": __type,
+                "default": __default,
+                "metadata": __metadata
+            })
+
+        # Return the list of field information dictionaries
+        return __fields

orionis-0.414.0/orionis/support/facades/console.py

@@ -0,0 +1,21 @@
+from orionis.container.facades.facade import Facade
+
+class Console(Facade):
+
+    @classmethod
+    def getFacadeAccessor(cls) -> str:
+        """
+        Returns the service container binding key used to resolve the console component.
+
+        This method provides the unique string identifier that the service container uses
+        to locate and instantiate the console service. It is typically used internally
+        by the Facade base class to delegate calls to the underlying implementation.
+
+        Returns
+        -------
+        str
+            The string key `"core.orionis.console"` that identifies the console service in the container.
+        """
+
+        # Return the binding key for the console service in the container
+        return "core.orionis.console"

orionis-0.414.0/orionis/support/facades/dumper.py

@@ -0,0 +1,21 @@
+from orionis.container.facades.facade import Facade
+
+class Dumper(Facade):
+
+    @classmethod
+    def getFacadeAccessor(cls) -> str:
+        """
+        Returns the binding key used to retrieve the dumper component from the service container.
+
+        This method provides the unique string identifier that the service container uses to resolve
+        and return the dumper service instance. It is typically used internally by the Facade base class
+        to access the underlying implementation.
+
+        Returns
+        -------
+        str
+            The string "core.orionis.dumper", which is the service container binding key for the dumper component.
+        """
+
+        # Return the service container binding key for the dumper component
+        return "core.orionis.dumper"

orionis-0.414.0/orionis/support/facades/logger.py

@@ -0,0 +1,22 @@
+from orionis.container.facades.facade import Facade
+
+class Log(Facade):
+
+    @classmethod
+    def getFacadeAccessor(cls) -> str:
+        """
+        Returns the binding key used to resolve the logger service from the service container.
+
+        This method provides the unique identifier required by the service container to retrieve
+        the logger component. It is used internally by the Facade base class to delegate calls
+        to the appropriate service implementation.
+
+        Returns
+        -------
+        str
+            The binding key for the logger service in the service container, specifically
+            "core.orionis.logger".
+        """
+
+        # Return the service container binding key for the logger component
+        return "core.orionis.logger"

orionis-0.414.0/orionis/support/facades/path_resolver.py

@@ -0,0 +1,22 @@
+from orionis.container.facades.facade import Facade
+
+class PathResolver(Facade):
+
+    @classmethod
+    def getFacadeAccessor(cls):
+        """
+        Returns the service container binding key used to resolve the path resolver component.
+
+        This method provides the unique string identifier that the service container uses
+        to locate and retrieve the path resolver service. It is typically used internally
+        by the facade mechanism to delegate calls to the appropriate underlying implementation.
+
+        Returns
+        -------
+        str
+            The string key "core.orionis.path_resolver" that identifies the path resolver
+            service in the container.
+        """
+
+        # Return the binding key for the path resolver service in the container
+        return "core.orionis.path_resolver"

orionis-0.414.0/orionis/support/facades/progress_bar.py

@@ -0,0 +1,22 @@
+from orionis.container.facades.facade import Facade
+
+class ProgressBar(Facade):
+
+    @classmethod
+    def getFacadeAccessor(cls):
+        """
+        Returns the binding key used to retrieve the progress bar service from the service container.
+
+        This method provides the unique string identifier that the service container uses to resolve
+        the progress bar component. It is typically used internally by the Facade system to access
+        the underlying implementation.
+
+        Returns
+        -------
+        str
+            The binding key for the progress bar service in the service container, specifically
+            "core.orionis.progress_bar".
+        """
+
+        # Return the service container binding key for the progress bar component
+        return "core.orionis.progress_bar"

orionis-0.414.0/orionis/support/facades/testing.py

@@ -0,0 +1,22 @@
+from orionis.container.facades.facade import Facade
+
+class Test(Facade):
+
+    @classmethod
+    def getFacadeAccessor(cls) -> str:
+        """
+        Returns the service container binding key for the testing component.
+
+        This method provides the unique string identifier used by the service container
+        to resolve the testing component. It is typically used internally by the Facade
+        system to retrieve the correct implementation from the container.
+
+        Returns
+        -------
+        str
+            The string key "core.orionis.testing" that identifies the testing component
+            in the service container.
+        """
+
+        # Return the binding key for the testing component in the service container
+        return "core.orionis.testing"

orionis-0.414.0/orionis/support/facades/workers.py

@@ -0,0 +1,22 @@
+from orionis.container.facades.facade import Facade
+
+class Workers(Facade):
+
+    @classmethod
+    def getFacadeAccessor(cls):
+        """
+        Returns the service container binding key for the workers component.
+
+        This method provides the unique string identifier used by the service container
+        to resolve the workers service. It is typically used internally by the Facade
+        mechanism to access the underlying implementation.
+
+        Returns
+        -------
+        str
+            The string key "core.orionis.workers" that identifies the workers service
+            in the service container.
+        """
+
+        # Return the binding key for the workers service in the container
+        return "core.orionis.workers"

{orionis-0.413.0 → orionis-0.414.0/orionis.egg-info}/PKG-INFO

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

{orionis-0.413.0 → orionis-0.414.0}/orionis.egg-info/SOURCES.txt

@@ -556,6 +556,9 @@ tests/services/system/__init__.py
 tests/services/system/test_services_system_imports.py
 tests/services/system/test_services_system_workers.py
 tests/support/__init__.py
+tests/support/entities/__init__.py
+tests/support/entities/mock_dataclass.py
+tests/support/entities/test_base.py
 tests/support/patterns/__init__.py
 tests/support/patterns/singleton/__init__.py
 tests/support/patterns/singleton/test_patterns_singleton.py

orionis-0.414.0/tests/support/entities/mock_dataclass.py

@@ -0,0 +1,34 @@
+from dataclasses import dataclass, field
+from enum import Enum
+from orionis.support.entities.base import BaseEntity
+
+class Color(Enum):
+    """Enumeration for available colors."""
+    RED = 1
+    GREEN = 2
+
+@dataclass
+class ExampleEntity(BaseEntity):
+    """
+    Example entity representing a data structure with id, name, color, and tags.
+
+    Attributes
+    ----------
+    id : int
+        Unique identifier for the entity.
+    name : str
+        Name of the entity.
+    color : Color
+        Color associated with the entity.
+    tags : list
+        List of tags associated with the entity.
+
+    Returns
+    -------
+    ExampleEntity
+        An instance of ExampleEntity with specified attributes.
+    """
+    id: int = 0  # Default id is 0
+    name: str = "default"  # Default name is 'default'
+    color: Color = Color.RED  # Default color is RED
+    tags: list = field(default_factory=list, metadata={"default": ["tag1", "tag2"]})  # Default tags list

orionis-0.414.0/tests/support/entities/test_base.py

@@ -0,0 +1,72 @@
+from orionis.test.cases.asynchronous import AsyncTestCase
+from tests.support.entities.mock_dataclass import Color, ExampleEntity
+
+class TestBaseEntity(AsyncTestCase):
+
+    async def asyncSetUp(self):
+        """
+        Set up the test case asynchronously by initializing an ExampleEntity instance.
+
+        This method is called before each test coroutine to prepare the test environment.
+        It creates an ExampleEntity with predefined attributes.
+
+        Returns
+        -------
+        None
+            This method does not return any value.
+        """
+        # Create an ExampleEntity instance for use in tests
+        self.entity = ExampleEntity(id=42, name="test", color=Color.GREEN, tags=["a", "b"])
+
+    async def testToDict(self):
+        """
+        Test the toDict method of ExampleEntity.
+
+        Verifies that the toDict method returns a dictionary representation of the entity
+        with correct field values.
+
+        Returns
+        -------
+        None
+            This method does not return any value.
+        """
+
+        # Convert entity to dictionary
+        result = self.entity.toDict()
+        self.assertIsInstance(result, dict)
+
+        # Check individual field values
+        self.assertEqual(result["id"], 42)
+        self.assertEqual(result["name"], "test")
+        self.assertEqual(result["color"], Color.GREEN)
+        self.assertEqual(result["tags"], ["a", "b"])
+
+    async def testGetFields(self):
+        """
+        Test the getFields method of ExampleEntity.
+
+        Ensures that getFields returns a list of field information dictionaries,
+        each containing field name, types, default value, and metadata.
+
+        Returns
+        -------
+        None
+            This method does not return any value.
+        """
+
+        # Retrieve field information from entity
+        fields_info = self.entity.getFields()
+        self.assertIsInstance(fields_info, list)
+
+        # Extract field names for verification
+        names = [f["name"] for f in fields_info]
+        self.assertIn("id", names)
+        self.assertIn("name", names)
+        self.assertIn("color", names)
+        self.assertIn("tags", names)
+
+        # Check that each field info contains required keys
+        for f in fields_info:
+            self.assertIn("types", f)
+            self.assertIn("default", f)
+            self.assertIn("metadata", f)

orionis-0.413.0/orionis/support/entities/base.py

@@ -1,104 +0,0 @@
-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-0.413.0/orionis/support/facades/console.py

@@ -1,15 +0,0 @@
-from orionis.container.facades.facade import Facade
-
-class Console(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.console"

orionis-0.413.0/orionis/support/facades/dumper.py

@@ -1,15 +0,0 @@
-from orionis.container.facades.facade import Facade
-
-class Dumper(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.dumper"

orionis-0.413.0/orionis/support/facades/logger.py

@@ -1,15 +0,0 @@
-from orionis.container.facades.facade import Facade
-
-class Log(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.logger"

orionis-0.413.0/orionis/support/facades/path_resolver.py

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

orionis-0.413.0/orionis/support/facades/progress_bar.py

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

orionis-0.413.0/orionis/support/facades/testing.py

@@ -1,15 +0,0 @@
-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-0.413.0/orionis/support/facades/workers.py

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