orionis 0.413.0__py3-none-any.whl → 0.414.0__py3-none-any.whl

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/support/entities/base.py

@@ -5,57 +5,77 @@ class BaseEntity:
 
     def toDict(self) -> dict:
         """
-        Converts the current instance into a dictionary representation.
+        Converts the current dataclass instance into a dictionary.
+
+        Parameters
+        ----------
+        None
 
         Returns
         -------
         dict
-            Dictionary representation of the current instance.
+            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 a list of field information for the current dataclass instance.
+        Retrieves detailed information about each field in the current dataclass instance.
+
+        Parameters
+        ----------
+        None
 
         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.
+        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.
         """
-        # Dictionary to hold field information
+
+        # List to hold field information dictionaries
         __fields = []
 
-        # Iterate over the fields of the dataclass and extract relevant information
+        # Iterate over all fields defined in the dataclass
         for field in fields(self):
 
-            # Get the field name
+            # Extract the field name
             __name = field.name
 
-            # Get the field type with better handling for complex types
+            # Attempt to get the type name; handles simple types
             __type = getattr(field.type, '__name__', None)
 
-            # If the type is None, handle it
+            # If type name is not available, handle complex types (e.g., Unions)
             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
+            # Ensure __type is always a list for consistency
             __type = type_lst if isinstance(__type, list) else [__type]
 
-            # Extract metadata, default value, and type
+            # Extract metadata as a dictionary
             metadata = dict(field.metadata) if field.metadata else {}
 
-            # If metadata contains a default value, normalize it
+            # Normalize default value in metadata if present
             if 'default' in metadata:
                 metadata_default = metadata['default']
                 if callable(metadata_default):
@@ -66,13 +86,12 @@ class BaseEntity:
                     metadata_default = metadata_default.value
                 metadata['default'] = metadata_default
 
-            # Add the field information to the list
             __metadata = metadata
 
-            # Extract the default value, if specified
+            # Initialize default value
             __default = None
 
-            # Field has a direct default value
+            # 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):
@@ -80,7 +99,7 @@ class BaseEntity:
                 elif isinstance(__default, Enum):
                     __default = __default.value
 
-            # Field has a default factory (like list, dict, etc.)
+            # 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):
@@ -88,11 +107,11 @@ class BaseEntity:
                 elif isinstance(__default, Enum):
                     __default = __default.value
 
-            # No default found, check metadata for custom default
+            # If no default found, check metadata for custom default
             else:
                 __default = __metadata.get('default', None)
 
-            # Append the field information to the list
+            # Append the field information dictionary to the list
             __fields.append({
                 "name": __name,
                 "types": __type,
@@ -100,5 +119,5 @@ class BaseEntity:
                 "metadata": __metadata
             })
 
-        # Return the list of field information
+        # Return the list of field information dictionaries
         return __fields

orionis/support/facades/console.py

@@ -5,11 +5,17 @@ class Console(Facade):
     @classmethod
     def getFacadeAccessor(cls) -> str:
         """
-        Get the service container binding key for the dumper component.
+        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 service container binding key.
+            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/support/facades/dumper.py

@@ -5,11 +5,17 @@ class Dumper(Facade):
     @classmethod
     def getFacadeAccessor(cls) -> str:
         """
-        Get the service container binding key for the dumper component.
+        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 service container binding key.
+            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/support/facades/logger.py

@@ -5,11 +5,18 @@ class Log(Facade):
     @classmethod
     def getFacadeAccessor(cls) -> str:
         """
-        Get the service container binding key for the dumper component.
+        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 service container binding key.
+            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/support/facades/path_resolver.py

@@ -5,11 +5,18 @@ class PathResolver(Facade):
     @classmethod
     def getFacadeAccessor(cls):
         """
-        Get the service container binding key for the dumper component.
+        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 service container binding key.
+            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/support/facades/progress_bar.py

@@ -5,11 +5,18 @@ class ProgressBar(Facade):
     @classmethod
     def getFacadeAccessor(cls):
         """
-        Get the service container binding key for the dumper component.
+        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 service container binding key.
+            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/support/facades/testing.py

@@ -5,11 +5,18 @@ class Test(Facade):
     @classmethod
     def getFacadeAccessor(cls) -> str:
         """
-        Get the service container binding key for the dumper component.
+        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 service container binding key.
+            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/support/facades/workers.py

@@ -5,11 +5,18 @@ class Workers(Facade):
     @classmethod
     def getFacadeAccessor(cls):
         """
-        Get the service container binding key for the dumper component.
+        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 service container binding key.
+            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.dist-info → orionis-0.414.0.dist-info}/METADATA

@@ -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.dist-info → orionis-0.414.0.dist-info}/RECORD

@@ -258,7 +258,7 @@ orionis/foundation/providers/progress_bar_provider.py,sha256=WW3grNgH-yV2meSSTeO
 orionis/foundation/providers/testing_provider.py,sha256=iJSN2RIChbYIL-1ue6vmPmDMCSrvERDkti4Er9MPiLA,1102
 orionis/foundation/providers/workers_provider.py,sha256=kiQjQRyUEyiBX2zcbF_KmqRgvc7Bvxsvg5oMtIvYniM,1075
 orionis/metadata/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-orionis/metadata/framework.py,sha256=jqDMZrSdfmPEJySPYTgu3zVGmQxZLzJKHYcCjiIq5TQ,4960
+orionis/metadata/framework.py,sha256=scI_a_NbPmaG7Rcwj0yNpwodYHHU3Hi_q0gLxzIRCdg,4960
 orionis/metadata/package.py,sha256=tqLfBRo-w1j_GN4xvzUNFyweWYFS-qhSgAEc-AmCH1M,5452
 orionis/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/services/asynchrony/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -354,15 +354,15 @@ orionis/services/system/runtime/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm
 orionis/services/system/runtime/imports.py,sha256=iIwIx8RjBHaiveCdj_WPiMMbWsKGbIs02qpAzL_L3Z0,3158
 orionis/support/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/support/entities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-orionis/support/entities/base.py,sha256=4WuAzrk_sfWp8Wv5Yl9IUF6kTctlAXlSxHGh5mdu3MQ,3982
+orionis/support/entities/base.py,sha256=UKDEpScz7ZeckCqD9TNxAhk0ZN9UPgrRQOpUUHVtfqg,4845
 orionis/support/facades/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-orionis/support/facades/console.py,sha256=Hx_VGZazpdPDkg1LgcCTzgASq7blzazGHXVNp2uN5w8,372
-orionis/support/facades/dumper.py,sha256=JD0xT11ReLlzTH1O5wdIG1-r9sg1nriJnhtqkLsavW8,370
-orionis/support/facades/logger.py,sha256=TWJP2OKiGIECnPqbCbxxNpgbhSFeqVaQkYOIVclYPdk,367
-orionis/support/facades/path_resolver.py,sha256=-ro3-yxmjKHngf6aOy2dzyeNulsiSJuxu__vJWsRuUA,376
-orionis/support/facades/progress_bar.py,sha256=ZmU7hojRP88PM39BX1fN0_2pTCUhOXdIqyKaQwPoQ-A,374
-orionis/support/facades/testing.py,sha256=sDnW_jzM_uU1Cyrg-6tFnpb45k_OiSy3_QNdlF2WOck,369
-orionis/support/facades/workers.py,sha256=XbDYSh_LCRzQI1jNEtBrB82Q6_iRg7i8lEzuyF5Om9E,365
+orionis/support/facades/console.py,sha256=YAVAdP0TjLjKoBVU18mVl1MtMGWjbKJoYxZRlm1ZwUI,792
+orionis/support/facades/dumper.py,sha256=Yxn_6sU3ijo8dXGZRDLi_S2lNJoeJtCeLX5GI4Jn0u4,803
+orionis/support/facades/logger.py,sha256=VpDp7iXfAnkHxCQvwhcIT1XdJAWOfLsEkY-u_mGIuN8,796
+orionis/support/facades/path_resolver.py,sha256=V_Mxf5-REBp9boeTR4FGM4M_QwGlIeRQIEoX-kb164g,845
+orionis/support/facades/progress_bar.py,sha256=JB3CvXrlnBLONdQ0lygOYs1FAzYnXQLtih8C3R7xP8g,824
+orionis/support/facades/testing.py,sha256=ZGRe0zhcgybKb8yx-Ysskg2c7FlTdss52uBYdGV8EeU,796
+orionis/support/facades/workers.py,sha256=jJNFE_yjy-3uaqG8ynPTagnwOFLSGC50PsveDG4t4uE,763
 orionis/support/formatter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/support/formatter/serializer.py,sha256=g816osgwYzAzCnduDh2IyHvXx-fEhnVmw8EPZkDT5Ak,522
 orionis/support/formatter/exceptions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -428,7 +428,7 @@ orionis/test/validators/web_report.py,sha256=-h3Fe9jY93_kzUhd2NBIqEfCcBpu-8Ei9x3
 orionis/test/validators/workers.py,sha256=LGffDKtK6SKixFKzIYPQpI5aFeQPAGXpv_LUtmEu6g4,1102
 orionis/test/view/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/test/view/render.py,sha256=3ICz68l-WF3BtnYqH5m-ktN9UD00MELMbmMnyJDV74A,4768
-orionis-0.413.0.dist-info/licenses/LICENCE,sha256=-_4cF2EBKuYVS_SQpy1uapq0oJPUU1vl_RUWSy2jJTo,1111
+orionis-0.414.0.dist-info/licenses/LICENCE,sha256=-_4cF2EBKuYVS_SQpy1uapq0oJPUU1vl_RUWSy2jJTo,1111
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/container/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/container/test_container.py,sha256=asv8TkkupVoex6SWod74NBl4dSs7wb9mLmu_glNdNy8,14815
@@ -547,6 +547,9 @@ tests/services/system/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3h
 tests/services/system/test_services_system_imports.py,sha256=jbtIQkw_4DI6x2E-4Lg3evnLAgCgDIBWE63LdJTLkxc,7507
 tests/services/system/test_services_system_workers.py,sha256=wITbpJHKW_OXqTaFeteNRFuw5Q3_7d9lWNJnFE2r6to,5052
 tests/support/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/support/entities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/support/entities/mock_dataclass.py,sha256=TZk4D1SdKqqz1kNaqLoMPlsl8s7dWOHIkSK5FsbyPRI,990
+tests/support/entities/test_base.py,sha256=z9lpDm8iY-gP-jv2VsLD-60NT-peBoTpB5jUsLt6V-A,2441
 tests/support/patterns/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/support/patterns/singleton/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/support/patterns/singleton/test_patterns_singleton.py,sha256=L7Q2QEBwSdG_JGfSB4s4AKqxsV4cXeKR1d8V7MbyzFY,1461
@@ -557,8 +560,8 @@ tests/support/wrapper/test_services_wrapper_docdict.py,sha256=Q_qyqZodLiTQ6Pv9zI
 tests/testing/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/testing/test_testing_result.py,sha256=aWOOJiHji_U7gcJHbDukgMmfBEEQCLQdyqpXJD5q4BE,4643
 tests/testing/test_testing_unit.py,sha256=Krz0Bw1toI9qvLtKtYe_slNvi7fYmZbHK1i4DRPMfUM,7952
-orionis-0.413.0.dist-info/METADATA,sha256=8xX9dll3RRMvC3_CLaMeRkUz59AoQUgxpEceM0lRF9w,4772
-orionis-0.413.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-orionis-0.413.0.dist-info/top_level.txt,sha256=2bdoHgyGZhOtLAXS6Om8OCTmL24dUMC_L1quMe_ETbk,14
-orionis-0.413.0.dist-info/zip-safe,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
-orionis-0.413.0.dist-info/RECORD,,
+orionis-0.414.0.dist-info/METADATA,sha256=rhoe5G18U85hjxlnKnYW9d6IQvL-sDyX81qYGfNT2M4,4772
+orionis-0.414.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+orionis-0.414.0.dist-info/top_level.txt,sha256=2bdoHgyGZhOtLAXS6Om8OCTmL24dUMC_L1quMe_ETbk,14
+orionis-0.414.0.dist-info/zip-safe,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
+orionis-0.414.0.dist-info/RECORD,,

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

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)