orionis 0.284.0__tar.gz → 0.286.0__tar.gz

{orionis-0.284.0/orionis.egg-info → orionis-0.286.0}/PKG-INFO

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

{orionis-0.284.0 → orionis-0.286.0}/orionis/metadata/framework.py

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

orionis-0.286.0/orionis/services/asynchrony/contracts/coroutines.py

@@ -0,0 +1,24 @@
+from abc import ABC, abstractmethod
+import asyncio
+from typing import TypeVar, Union
+
+T = TypeVar("T")
+
+class ICoroutine(ABC):
+
+    @abstractmethod
+    def run(self) -> Union[T, asyncio.Future]:
+        """
+        Execute the wrapped coroutine.
+
+        Returns
+        -------
+        result : T or asyncio.Future
+            The result of the coroutine if run synchronously, or a Future if run in an event loop.
+
+        Notes
+        -----
+        - If called from outside an event loop, this method will run the coroutine synchronously.
+        - If called from within an event loop, it will schedule the coroutine and return a Future.
+        """
+        pass

orionis-0.286.0/orionis/services/asynchrony/coroutines.py

@@ -0,0 +1,71 @@
+import asyncio
+from inspect import iscoroutine
+from typing import Any, Coroutine as TypingCoroutine, TypeVar, Union
+from orionis.services.asynchrony.contracts.coroutines import ICoroutine
+from orionis.services.asynchrony.exceptions.coroutine_exception import OrionisCoroutineException
+
+T = TypeVar("T")
+
+class Coroutine(ICoroutine):
+    """
+    Wrapper class for coroutine objects to facilitate execution in both synchronous
+    and asynchronous contexts.
+
+    Parameters
+    ----------
+    func : Coroutine
+        The coroutine object to be wrapped.
+
+    Raises
+    ------
+    OrionisCoroutineException
+        If the provided object is not a coroutine.
+    """
+
+    def __init__(self, func: TypingCoroutine[Any, Any, T]) -> None:
+        """
+        Initialize the Coroutine wrapper.
+
+        Parameters
+        ----------
+        func : Coroutine
+            The coroutine object to be wrapped.
+
+        Raises
+        ------
+        OrionisCoroutineException
+            If the provided object is not a coroutine.
+        """
+        if not iscoroutine(func):
+            raise OrionisCoroutineException(
+                f"Expected a coroutine object, but got {type(func).__name__}."
+            )
+        self.__func = func
+
+    def run(self) -> Union[T, asyncio.Future]:
+        """
+        Execute the wrapped coroutine.
+
+        Returns
+        -------
+        result : T or asyncio.Future
+            The result of the coroutine if run synchronously, or a Future if run in an event loop.
+
+        Notes
+        -----
+        - If called from outside an event loop, this method will run the coroutine synchronously.
+        - If called from within an event loop, it will schedule the coroutine and return a Future.
+        """
+        try:
+            # Get the current event loop
+            loop = asyncio.get_running_loop()
+        except RuntimeError:
+            # No running event loop, run synchronously
+            return asyncio.run(self.__func)
+
+        if loop.is_running():
+            # Inside an event loop, schedule as a Future
+            return asyncio.ensure_future(self.__func)
+        else:
+            # No running loop, run synchronously
+            return loop.run_until_complete(self.__func)

orionis-0.286.0/orionis/services/asynchrony/exceptions/coroutine_exception.py

@@ -0,0 +1,19 @@
+class OrionisCoroutineException(Exception):
+
+    def __init__(self, msg: str):
+        """
+        Parameters
+        ----------
+        msg : str
+            The error message describing the exception.
+        """
+        super().__init__(msg)
+
+    def __str__(self) -> str:
+        """
+        Returns
+        -------
+        str
+            A formatted string with the exception class name and its first argument.
+        """
+        return f"{self.__class__.__name__}: {self.args[0]}"

orionis-0.286.0/orionis/test/exceptions/test_config_exception.py

@@ -0,0 +1,19 @@
+class OrionisTestConfigException(Exception):
+
+    def __init__(self, msg: str):
+        """
+        Parameters
+        ----------
+        msg : str
+            Descriptive error message explaining the cause of the exception.
+        """
+        super().__init__(msg)
+
+    def __str__(self) -> str:
+        """
+        Returns
+        -------
+        str
+            Formatted string describing the exception, including the exception name and error message.
+        """
+        return f"{self.__class__.__name__}: {self.args[0]}"

orionis-0.286.0/orionis/test/exceptions/test_failure_exception.py

@@ -0,0 +1,52 @@
+import unittest
+
+class OrionisTestFailureException(Exception):
+
+    def __init__(self, result: unittest.TestResult):
+        """
+        Initialize the exception with details about failed and errored tests.
+
+        Parameters
+        ----------
+        result : unittest.TestResult
+            The test result object containing information about test failures and errors.
+
+        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.
+        text : str
+            Formatted string summarizing the test failures and errors.
+
+        Raises
+        ------
+        Exception
+            If there are failed or errored tests, raises an exception with a summary message.
+        """
+        failed_tests = [test.id() for test, _ in result.failures]
+        errored_tests = [test.id() for test, _ in result.errors]
+
+        error_messages = []
+        for test in failed_tests:
+            error_messages.append(f"Test Fail: {test}")
+        for test in errored_tests:
+            error_messages.append(f"Test Error: {test}")
+
+        text = "\n".join(error_messages)
+
+        super().__init__(f"{len(failed_tests) + len(errored_tests)} test(s) failed or errored:\n{text}")
+
+    def __str__(self) -> str:
+        """
+        Return a string representation of the exception.
+
+        Returns
+        -------
+        str
+            A formatted string describing the exception, including the exception name and the message.
+        """
+        return f"{self.__class__.__name__}: {self.args[0]}"

orionis-0.286.0/orionis/test/exceptions/test_persistence_error.py

@@ -0,0 +1,24 @@
+class OrionisTestPersistenceError(Exception):
+
+    def __init__(self, msg: str):
+        """
+        Initialize the OrionisTestPersistenceError with a specific error message.
+
+        Parameters
+        ----------
+        msg : str
+            Descriptive error message explaining the cause of the exception.
+        """
+        super().__init__(msg)
+
+    def __str__(self) -> str:
+        """
+        Returns a formatted string representation of the exception.
+
+        Returns
+        -------
+        str
+            A formatted string describing the exception, including the exception
+            name and the error message.
+        """
+        return f"{self.__class__.__name__}: {self.args[0]}"

orionis-0.286.0/orionis/test/exceptions/test_runtime_error.py

@@ -0,0 +1,19 @@
+class OrionisTestRuntimeError(Exception):
+
+    def __init__(self, msg: str):
+        """
+        Parameters
+        ----------
+        msg : str
+            The error message describing the runtime error.
+        """
+        super().__init__(msg)
+
+    def __str__(self) -> str:
+        """
+        Returns
+        -------
+        str
+            String representation of the exception in the format '<ClassName>: <first argument>'.
+        """
+        return f"{self.__class__.__name__}: {self.args[0]}"

orionis-0.286.0/orionis/test/exceptions/test_value_error.py

@@ -0,0 +1,19 @@
+class OrionisTestValueError(Exception):
+
+    def __init__(self, msg: str):
+        """
+        Parameters
+        ----------
+        msg : str
+            The error message describing the exception.
+        """
+        super().__init__(msg)
+
+    def __str__(self) -> str:
+        """
+        Returns
+        -------
+        str
+            A formatted string in the form 'ClassName: message', including the class name and the first argument.
+        """
+        return f"{self.__class__.__name__}: {self.args[0]}"

{orionis-0.284.0 → orionis-0.286.0/orionis.egg-info}/PKG-INFO

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

{orionis-0.284.0 → orionis-0.286.0}/orionis.egg-info/SOURCES.txt

@@ -244,6 +244,8 @@ orionis/patterns/singleton/meta_class.py
 orionis/services/__init__.py
 orionis/services/asynchrony/__init__.py
 orionis/services/asynchrony/coroutines.py
+orionis/services/asynchrony/contracts/__init__.py
+orionis/services/asynchrony/contracts/coroutines.py
 orionis/services/asynchrony/exceptions/__init__.py
 orionis/services/asynchrony/exceptions/coroutine_exception.py
 orionis/services/environment/__init__.py

{orionis-0.284.0 → orionis-0.286.0}/tests/services/asynchrony/test_async_io.py

@@ -1,5 +1,5 @@
 
-from orionis.services.asynchrony.coroutines import run_coroutine
+from orionis.services.asynchrony.coroutines import Coroutine
 from orionis.services.asynchrony.exceptions.coroutine_exception import OrionisCoroutineException
 from orionis.unittesting import TestCase
 
@@ -14,7 +14,7 @@ class TestsAsyncIO(TestCase):
         async def sample_coroutine():
             return "Hello, World!"
 
-        result = await run_coroutine(sample_coroutine())
+        result = await Coroutine(sample_coroutine()).run()
         self.assertEqual(result, "Hello, World!")
 
     def testExecuteWithoutActiveEventLoop(self):
@@ -25,7 +25,7 @@ class TestsAsyncIO(TestCase):
         async def sample_coroutine():
             return "Hello, World!"
 
-        result = run_coroutine(sample_coroutine())
+        result = Coroutine(sample_coroutine()).run()
         self.assertEqual(result, "Hello, World!")
 
     def testExecuteWithNonCoroutine(self):
@@ -37,4 +37,4 @@ class TestsAsyncIO(TestCase):
             return "Hello, World!"
 
         with self.assertRaises(OrionisCoroutineException):
-            run_coroutine(sample_no_coroutine())
+            Coroutine(sample_no_coroutine())

orionis-0.284.0/orionis/services/asynchrony/coroutines.py

@@ -1,32 +0,0 @@
-import asyncio
-from typing import Any, Coroutine, TypeVar, Union
-from orionis.services.asynchrony.exceptions.coroutine_exception import OrionisCoroutineException
-
-T = TypeVar("T")
-
-def run_coroutine(coro: Coroutine[Any, Any, T]) -> Union[T, asyncio.Future]:
-    """
-    Executes the given coroutine object, adapting to the current execution context.
-    If there is an active event loop, it uses `asyncio.ensure_future` to schedule the coroutine.
-    If there is no active event loop, it uses `asyncio.run` to run the coroutine directly.
-    If the coroutine is already running, it returns a `Future` object that can be awaited.
-
-    Parameters
-    ----------
-    coro : Coroutine[Any, Any, T]
-        The coroutine object
-    """
-    from inspect import iscoroutine
-
-    if not iscoroutine(coro):
-        raise OrionisCoroutineException("Expected a coroutine object.")
-
-    try:
-        loop = asyncio.get_running_loop()
-    except RuntimeError:
-        return asyncio.run(coro)
-
-    if loop.is_running():
-        return asyncio.ensure_future(coro)
-    else:
-        return loop.run_until_complete(coro)

orionis-0.284.0/orionis/services/asynchrony/exceptions/coroutine_exception.py

@@ -1,26 +0,0 @@
-class OrionisCoroutineException(Exception):
-    """
-    Exception raised for errors related to coroutine operations in the Orionis framework.
-    This exception is intended to signal issues encountered during asynchronous
-    operations, providing a clear and descriptive error message to facilitate debugging.
-        msg (str): A detailed message describing the cause of the exception.
-    Example:
-        raise OrionisCoroutineException("Coroutine execution failed due to timeout.")
-    """
-
-    def __init__(self, msg: str):
-        """
-        Initialize the exception with a custom error message.
-        Args:
-            msg (str): The error message describing the exception.
-        """
-        super().__init__(msg)
-
-    def __str__(self) -> str:
-        """
-        Return a string representation of the exception, including the class name and the first argument.
-
-        Returns:
-            str: A formatted string with the exception class name and its first argument.
-        """
-        return f"{self.__class__.__name__}: {self.args[0]}"

orionis-0.284.0/orionis/test/exceptions/test_config_exception.py

@@ -1,28 +0,0 @@
-class OrionisTestConfigException(Exception):
-    """
-    Custom exception for test configuration errors in the Orionis framework.
-
-    This exception is raised when there is an issue with the test configuration,
-    providing a clear and descriptive error message to aid in debugging.
-    """
-
-    def __init__(self, msg: str):
-        """
-        Initializes the OrionisTestConfigException with a specific error message.
-
-        Args:
-            msg (str): A descriptive error message explaining the cause of the exception.
-        """
-        super().__init__(msg)
-
-    def __str__(self) -> str:
-        """
-        Returns a formatted string representation of the exception.
-
-        The string includes the exception name and the error message, providing
-        a clear and concise description of the issue.
-
-        Returns:
-            str: A formatted string describing the exception.
-        """
-        return f"{self.__class__.__name__}: {self.args[0]}"

orionis-0.284.0/orionis/test/exceptions/test_failure_exception.py

@@ -1,52 +0,0 @@
-import unittest
-
-class OrionisTestFailureException(Exception):
-    """
-    OrionisTestFailureException is a custom exception class used to handle test failures and errors
-    in a structured manner. It provides detailed information about the failed and errored tests,
-    including their IDs and formatted error messages.
-    Methods:
-        __init__(result: unittest.TestResult):
-        __str__() -> str:
-    """
-
-    def __init__(self, result: unittest.TestResult):
-        """
-        Initializes the exception with details about failed and errored tests.
-        Args:
-            result (unittest.TestResult): The test result object containing information
-                about test failures and errors.
-        Attributes:
-            failed_tests (list): A list of IDs for tests that failed.
-            errored_tests (list): A list of IDs for tests that encountered errors.
-            error_messages (list): A list of formatted error messages for failed and errored tests.
-            text (str): A formatted string summarizing the test failures and errors.
-        Raises:
-            Exception: An exception with a message summarizing the number of failed
-                and errored tests along with their details.
-        """
-        failed_tests = [test.id() for test, _ in result.failures]
-        errored_tests = [test.id() for test, _ in result.errors]
-
-        error_messages = []
-        for test in failed_tests:
-            error_messages.append(f"Test Fail: {test}")
-        for test in errored_tests:
-            error_messages.append(f"Test Error: {test}")
-
-        text = "\n".join(error_messages)
-
-        super().__init__(f"{len(failed_tests) + len(errored_tests)} test(s) failed or errored:\n{text}")
-
-    def __str__(self) -> str:
-        """
-        Returns a string representation of the exception.
-
-        The string includes the exception name and the first argument
-        passed to the exception, providing a clear description of the
-        test failure.
-
-        Returns:
-            str: A formatted string describing the exception.
-        """
-        return f"{self.__class__.__name__}: {self.args[0]}"

orionis-0.284.0/orionis/test/exceptions/test_persistence_error.py

@@ -1,34 +0,0 @@
-class OrionisTestPersistenceError(Exception):
-    """
-    Custom exception for persistence errors in tests within the Orionis framework.
-
-    This exception is used to indicate issues related to data persistence during test execution,
-    providing a descriptive message to help identify and resolve the error.
-
-    Args:
-        msg (str): A descriptive message explaining the cause of the persistence error.
-
-    Example:
-        raise OrionisTestPersistenceError("Failed to save test state to the database.")
-    """
-
-    def __init__(self, msg: str):
-        """
-        Initializes the OrionisTestConfigException with a specific error message.
-
-        Args:
-            msg (str): A descriptive error message explaining the cause of the exception.
-        """
-        super().__init__(msg)
-
-    def __str__(self) -> str:
-        """
-        Returns a formatted string representation of the exception.
-
-        The string includes the exception name and the error message, providing
-        a clear and concise description of the issue.
-
-        Returns:
-            str: A formatted string describing the exception.
-        """
-        return f"{self.__class__.__name__}: {self.args[0]}"

orionis-0.284.0/orionis/test/exceptions/test_runtime_error.py

@@ -1,26 +0,0 @@
-class OrionisTestRuntimeError(Exception):
-    """
-    Exception raised for errors that occur during the runtime of Orionis tests.
-    This exception is intended to provide a clear and descriptive error message
-    when a runtime error is encountered in the Orionis testing framework.
-    Attributes:
-    Example:
-        raise OrionisTestRuntimeError("An unexpected runtime error occurred during testing.")
-    """
-
-    def __init__(self, msg: str):
-        """
-        Initializes the exception with a given error message.
-        Args:
-            msg (str): The error message describing the runtime error.
-        """
-        super().__init__(msg)
-
-    def __str__(self) -> str:
-        """
-        Return a string representation of the exception, including the class name and the first argument.
-
-        Returns:
-            str: A string in the format '<ClassName>: <first argument>'.
-        """
-        return f"{self.__class__.__name__}: {self.args[0]}"

orionis-0.284.0/orionis/test/exceptions/test_value_error.py

@@ -1,26 +0,0 @@
-class OrionisTestValueError(Exception):
-    """
-    Custom exception class for handling value errors in the Orionis test framework.
-    This exception should be raised when a value-related error occurs during testing.
-    It provides a formatted string representation that includes the class name and the error message.
-    Example:
-        raise OrionisTestValueError("Invalid value provided.")
-    """
-
-    def __init__(self, msg: str):
-        """
-        Initializes the exception with a custom error message.
-
-        Args:
-            msg (str): The error message describing the exception.
-        """
-        super().__init__(msg)
-
-    def __str__(self) -> str:
-        """
-        Return a string representation of the exception, including the class name and the first argument.
-
-        Returns:
-            str: A formatted string in the form 'ClassName: message'.
-        """
-        return f"{self.__class__.__name__}: {self.args[0]}"