orionis 0.313.0__py3-none-any.whl → 0.315.0__py3-none-any.whl

orionis/services/introspection/reflection.py

@@ -1,3 +1,4 @@
+import inspect
 from typing import Any, Type
 from orionis.services.introspection.abstract.reflection_abstract import ReflectionAbstract
 from orionis.services.introspection.concretes.reflection_concrete import ReflectionConcrete
@@ -11,80 +12,429 @@ class Reflection:
     This class offers factory methods to obtain specialized reflection objects for instances,
     abstract classes, concrete classes, and modules. Each method returns an object that
     encapsulates the target and provides introspection capabilities.
-
-    Methods
-    -------
-    instance(instance: Any) -> ReflectionInstance
-        Create a reflection object for a class instance.
-    abstract(abstract: Type) -> ReflectionAbstract
-        Create a reflection object for an abstract class.
-    concrete(concrete: Type) -> ReflectionConcrete
-        Create a reflection object for a concrete class.
-    module(module: str) -> ReflectionModule
-        Create a reflection object for a module.
     """
 
     @staticmethod
     def instance(instance: Any) -> 'ReflectionInstance':
         """
-        Create a reflection object for a class instance.
+        Create a ReflectionInstance for the given object instance.
 
         Parameters
         ----------
         instance : Any
-            The instance to reflect upon.
+            The object instance to reflect.
 
         Returns
         -------
         ReflectionInstance
-            A reflection object encapsulating the instance.
+            A reflection object for the given instance.
         """
         return ReflectionInstance(instance)
 
     @staticmethod
     def abstract(abstract: Type) -> 'ReflectionAbstract':
-        """Create a reflection object for an abstract class.
+        """
+        Create a ReflectionAbstract for the given abstract class.
 
         Parameters
         ----------
         abstract : Type
-            The abstract class to reflect upon
+            The abstract class to reflect.
 
         Returns
         -------
         ReflectionAbstract
-            A reflection object encapsulating the abstract class
+            A reflection object for the given abstract class.
         """
         return ReflectionAbstract(abstract)
 
     @staticmethod
     def concrete(concrete: Type) -> 'ReflectionConcrete':
-        """Create a reflection object for a concrete class.
+        """
+        Create a ReflectionConcrete for the given concrete class.
 
         Parameters
         ----------
         concrete : Type
-            The concrete class to reflect upon
+            The concrete class to reflect.
 
         Returns
         -------
         ReflectionConcrete
-            A reflection object encapsulating the concrete class
+            A reflection object for the given concrete class.
         """
         return ReflectionConcrete(concrete)
 
     @staticmethod
     def module(module: str) -> 'ReflectionModule':
-        """Create a reflection object for a module.
+        """
+        Create a ReflectionModule for the given module name.
 
         Parameters
         ----------
         module : str
-            The module name to reflect upon
+            The name of the module to reflect.
 
         Returns
         -------
         ReflectionModule
-            A reflection object encapsulating the module
+            A reflection object for the given module.
         """
         return ReflectionModule(module)
+
+    @staticmethod
+    def isAbstract(obj: Any) -> bool:
+        """
+        Check if the object is an abstract base class.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is abstract, False otherwise.
+        """
+        return inspect.isabstract(obj)
+
+    @staticmethod
+    def isAsyncGen(obj: Any) -> bool:
+        """
+        Check if the object is an asynchronous generator.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is an async generator, False otherwise.
+        """
+        return inspect.isasyncgen(obj)
+
+    @staticmethod
+    def isAsyncGenFunction(obj: Any) -> bool:
+        """
+        Check if the object is an asynchronous generator function.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is an async generator function, False otherwise.
+        """
+        return inspect.isasyncgenfunction(obj)
+
+    @staticmethod
+    def isAwaitable(obj: Any) -> bool:
+        """
+        Check if the object can be awaited.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is awaitable, False otherwise.
+        """
+        return inspect.isawaitable(obj)
+
+    @staticmethod
+    def isBuiltin(obj: Any) -> bool:
+        """
+        Check if the object is a built-in function or method.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is a built-in, False otherwise.
+        """
+        return inspect.isbuiltin(obj)
+
+    @staticmethod
+    def isClass(obj: Any) -> bool:
+        """
+        Check if the object is a class.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is a class, False otherwise.
+        """
+        return inspect.isclass(obj)
+
+    @staticmethod
+    def isCode(obj: Any) -> bool:
+        """
+        Check if the object is a code object.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is a code object, False otherwise.
+        """
+        return inspect.iscode(obj)
+
+    @staticmethod
+    def isCoroutine(obj: Any) -> bool:
+        """
+        Check if the object is a coroutine.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is a coroutine, False otherwise.
+        """
+        return inspect.iscoroutine(obj)
+
+    @staticmethod
+    def isCoroutineFunction(obj: Any) -> bool:
+        """
+        Check if the object is a coroutine function.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is a coroutine function, False otherwise.
+        """
+        return inspect.iscoroutinefunction(obj)
+
+    @staticmethod
+    def isDataDescriptor(obj: Any) -> bool:
+        """
+        Check if the object is a data descriptor.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is a data descriptor, False otherwise.
+        """
+        return inspect.isdatadescriptor(obj)
+
+    @staticmethod
+    def isFrame(obj: Any) -> bool:
+        """
+        Check if the object is a frame object.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is a frame object, False otherwise.
+        """
+        return inspect.isframe(obj)
+
+    @staticmethod
+    def isFunction(obj: Any) -> bool:
+        """
+        Check if the object is a Python function.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is a function, False otherwise.
+        """
+        return inspect.isfunction(obj)
+
+    @staticmethod
+    def isGenerator(obj: Any) -> bool:
+        """
+        Check if the object is a generator.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is a generator, False otherwise.
+        """
+        return inspect.isgenerator(obj)
+
+    @staticmethod
+    def isGeneratorFunction(obj: Any) -> bool:
+        """
+        Check if the object is a generator function.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is a generator function, False otherwise.
+        """
+        return inspect.isgeneratorfunction(obj)
+
+    @staticmethod
+    def isGetSetDescriptor(obj: Any) -> bool:
+        """
+        Check if the object is a getset descriptor.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is a getset descriptor, False otherwise.
+        """
+        return inspect.isgetsetdescriptor(obj)
+
+    @staticmethod
+    def isMemberDescriptor(obj: Any) -> bool:
+        """
+        Check if the object is a member descriptor.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is a member descriptor, False otherwise.
+        """
+        return inspect.ismemberdescriptor(obj)
+
+    @staticmethod
+    def isMethod(obj: Any) -> bool:
+        """
+        Check if the object is a method.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is a method, False otherwise.
+        """
+        return inspect.ismethod(obj)
+
+    @staticmethod
+    def isMethodDescriptor(obj: Any) -> bool:
+        """
+        Check if the object is a method descriptor.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is a method descriptor, False otherwise.
+        """
+        return inspect.ismethoddescriptor(obj)
+
+    @staticmethod
+    def isModule(obj: Any) -> bool:
+        """
+        Check if the object is a module.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is a module, False otherwise.
+        """
+        return inspect.ismodule(obj)
+
+    @staticmethod
+    def isRoutine(obj: Any) -> bool:
+        """
+        Check if the object is a user-defined or built-in function or method.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is a routine, False otherwise.
+        """
+        return inspect.isroutine(obj)
+
+    @staticmethod
+    def isTraceback(obj: Any) -> bool:
+        """
+        Check if the object is a traceback object.
+
+        Parameters
+        ----------
+        obj : Any
+            The object to check.
+
+        Returns
+        -------
+        bool
+            True if the object is a traceback object, False otherwise.
+        """
+        return inspect.istraceback(obj)

orionis/test/contracts/printer.py

@@ -0,0 +1,188 @@
+from abc import ABC, abstractmethod
+from typing import Any, Dict
+
+class ITestPrinter(ABC):
+
+    @abstractmethod
+    def print(
+        self,
+        value: Any
+    ) -> None:
+        """
+        Prints a value to the console using the rich console.
+        Parameters
+        ----------
+        value : Any
+            The value to be printed. It can be a string, object, or any other type.
+        Notes
+        -----
+        - If the value is a string, it is printed directly.
+        - If the value is an object, its string representation is printed.
+        - If the value is a list, each item is printed on a new line.
+        """
+        pass
+
+    @abstractmethod
+    def startMessage(
+        self,
+        *,
+        print_result: bool,
+        length_tests: int,
+        execution_mode: str,
+        max_workers: int
+    ):
+        """
+        Displays a formatted start message for the test execution session.
+
+        Parameters
+        ----------
+        print_result : bool
+            Whether to print the start message.
+        length_tests : int
+            The total number of tests to be executed.
+        execution_mode : str
+            The mode of execution, either "parallel" or "sequential".
+        max_workers : int
+            The number of worker threads/processes for parallel execution.
+
+        Side Effects
+        ------------
+        Prints a styled panel with test session information to the console if `print_result` is True.
+        """
+        pass
+
+    @abstractmethod
+    def finishMessage(
+        self,
+        *,
+        print_result: bool,
+        summary: Dict[str, Any]
+    ) -> None:
+        """
+        Display a summary message for the test suite execution.
+
+        Parameters
+        ----------
+        summary : dict
+            Dictionary containing the test suite summary, including keys such as
+            'failed', 'errors', and 'total_time'.
+
+        Notes
+        -----
+        - If `self.print_result` is False, the method returns without displaying anything.
+        - Shows a status icon (✅ for success, ❌ for failure) based on the presence of
+          failures or errors in the test suite.
+        - Formats and prints the message within a styled panel using the `rich` library.
+        """
+        pass
+
+    @abstractmethod
+    def executePanel(
+        self,
+        *,
+        print_result: bool,
+        flatten_test_suite: list,
+        callable: callable
+    ):
+        """
+        Executes a test suite panel with optional live console output.
+
+        Parameters
+        ----------
+        print_result : bool
+            If True, displays a running message panel while executing the test suite.
+        flatten_test_suite : list
+            The flattened list of test cases or test suite items to be executed.
+        callable : callable
+            The function or method to execute the test suite.
+
+        Returns
+        -------
+        Any
+            The result returned by the provided callable after execution.
+
+        Notes
+        -----
+        This method manages the display of a running message panel using the Rich library,
+        depending on whether debugging is enabled in the test suite and whether results should be printed.
+        If debugging or dump calls are detected in the test code, a live console is used to display
+        real-time updates. Otherwise, a static panel is shown before executing the test suite.
+        """
+        pass
+
+    @abstractmethod
+    def linkWebReport(
+        self,
+        path: str
+    ):
+        """
+        Prints an elegant invitation to view the test results, with an underlined path.
+
+        Parameters
+        ----------
+        path : str or Path
+            The path to the test results report.
+        """
+        pass
+
+    @abstractmethod
+    def summaryTable(
+        self,
+        summary: Dict[str, Any]
+    ) -> None:
+        """
+        Prints a summary table of test results using the Rich library.
+
+        Parameters
+        ----------
+        summary : dict
+            Dictionary with the test summary data. Must contain the following keys:
+            total_tests : int
+                Total number of tests executed.
+            passed : int
+                Number of tests that passed.
+            failed : int
+                Number of tests that failed.
+            errors : int
+                Number of tests that had errors.
+            skipped : int
+                Number of tests that were skipped.
+            total_time : float
+                Total duration of the test execution in seconds.
+            success_rate : float
+                Percentage of tests that passed.
+
+        Returns
+        -------
+        None
+        """
+        pass
+
+    @abstractmethod
+    def displayResults(
+        self,
+        *,
+        print_result: bool,
+        summary: Dict[str, Any]
+    ) -> None:
+        """
+        Display the results of the test execution, including a summary table and detailed
+        information about failed or errored tests grouped by their test classes.
+
+        Parameters
+        ----------
+        summary : dict
+            Dictionary containing the summary of the test execution, including test details,
+            statuses, and execution times.
+
+        Notes
+        -----
+        - Prints a summary table of the test results.
+        - Groups failed and errored tests by their test class and displays them in a structured
+          format using panels.
+        - For each failed or errored test, displays the traceback in a syntax-highlighted panel
+          with additional metadata such as the test method name and execution time.
+        - Uses different icons and border colors to distinguish between failed and errored tests.
+        - Calls a finishing message method after displaying all results.
+        """
+        pass