orionis 0.365.0__py3-none-any.whl → 0.366.0__py3-none-any.whl

orionis/console/output/contracts/console.py

@@ -0,0 +1,453 @@
+from abc import ABC, abstractmethod
+from typing import List, Union, Optional
+
+class IConsole(ABC):
+    """
+    Interface contract for Console output functionality.
+
+    Defines the contract for printing formatted messages to the console with ANSI colors,
+    providing methods to print success, info, warning, and error messages with
+    optional timestamps, as well as general text formatting methods.
+    """
+
+    @abstractmethod
+    def success(self, message: str, timestamp: bool = True) -> None:
+        """
+        Prints a success message with a green background.
+
+        Parameters
+        ----------
+        message : str
+            The success message to print.
+        timestamp : bool, optional
+            Whether to include a timestamp (default is True).
+        """
+        pass
+
+    @abstractmethod
+    def textSuccess(self, message: str) -> None:
+        """
+        Prints a success message in green.
+
+        Parameters
+        ----------
+        message : str
+            The success message to print.
+        """
+        pass
+
+    @abstractmethod
+    def textSuccessBold(self, message: str) -> None:
+        """
+        Prints a bold success message in green.
+
+        Parameters
+        ----------
+        message : str
+            The success message to print.
+        """
+        pass
+
+    @abstractmethod
+    def info(self, message: str, timestamp: bool = True) -> None:
+        """
+        Prints an informational message with a blue background.
+
+        Parameters
+        ----------
+        message : str
+            The informational message to print.
+        timestamp : bool, optional
+            Whether to include a timestamp (default is True).
+        """
+        pass
+
+    @abstractmethod
+    def textInfo(self, message: str) -> None:
+        """
+        Prints an informational message in blue.
+
+        Parameters
+        ----------
+        message : str
+            The informational message to print.
+        """
+        pass
+
+    @abstractmethod
+    def textInfoBold(self, message: str) -> None:
+        """
+        Prints a bold informational message in blue.
+
+        Parameters
+        ----------
+        message : str
+            The informational message to print.
+        """
+        pass
+
+    @abstractmethod
+    def warning(self, message: str, timestamp: bool = True) -> None:
+        """
+        Prints a warning message with a yellow background.
+
+        Parameters
+        ----------
+        message : str
+            The warning message to print.
+        timestamp : bool, optional
+            Whether to include a timestamp (default is True).
+        """
+        pass
+
+    @abstractmethod
+    def textWarning(self, message: str) -> None:
+        """
+        Prints a warning message in yellow.
+
+        Parameters
+        ----------
+        message : str
+            The warning message to print.
+        """
+        pass
+
+    @abstractmethod
+    def textWarningBold(self, message: str) -> None:
+        """
+        Prints a bold warning message in yellow.
+
+        Parameters
+        ----------
+        message : str
+            The warning message to print.
+        """
+        pass
+
+    @abstractmethod
+    def fail(self, message: str, timestamp: bool = True) -> None:
+        """
+        Prints a failure message with a red background.
+
+        Parameters
+        ----------
+        message : str
+            The failure message to print.
+        timestamp : bool, optional
+            Whether to include a timestamp (default is True).
+        """
+        pass
+
+    @abstractmethod
+    def error(self, message: str, timestamp: bool = True) -> None:
+        """
+        Prints an error message with a red background.
+
+        Parameters
+        ----------
+        message : str
+            The error message to print.
+        timestamp : bool, optional
+            Whether to include a timestamp (default is True).
+        """
+        pass
+
+    @abstractmethod
+    def textError(self, message: str) -> None:
+        """
+        Prints an error message in red.
+
+        Parameters
+        ----------
+        message : str
+            The error message to print.
+        """
+        pass
+
+    @abstractmethod
+    def textErrorBold(self, message: str) -> None:
+        """
+        Prints a bold error message in red.
+
+        Parameters
+        ----------
+        message : str
+            The error message to print.
+        """
+        pass
+
+    @abstractmethod
+    def textMuted(self, message: str) -> None:
+        """
+        Prints a muted (gray) message.
+
+        Parameters
+        ----------
+        message : str
+            The message to print.
+        """
+        pass
+
+    @abstractmethod
+    def textMutedBold(self, message: str) -> None:
+        """
+        Prints a bold muted (gray) message.
+
+        Parameters
+        ----------
+        message : str
+            The message to print.
+        """
+        pass
+
+    @abstractmethod
+    def textUnderline(self, message: str) -> None:
+        """
+        Prints an underlined message.
+
+        Parameters
+        ----------
+        message : str
+            The message to print.
+        """
+        pass
+
+    @abstractmethod
+    def clear(self) -> None:
+        """
+        Clears the console screen.
+        """
+        pass
+
+    @abstractmethod
+    def clearLine(self) -> None:
+        """
+        Clears the current line in the console.
+        """
+        pass
+
+    @abstractmethod
+    def line(self) -> None:
+        """
+        Prints a horizontal line in the console.
+        """
+        pass
+
+    @abstractmethod
+    def newLine(self, count: int = 1) -> None:
+        """
+        Prints multiple new lines.
+
+        Parameters
+        ----------
+        count : int, optional
+            The number of new lines to print (default is 1).
+
+        Raises
+        ------
+        ValueError
+            If count is less than or equal to 0.
+        """
+        pass
+
+    @abstractmethod
+    def write(self, message: str) -> None:
+        """
+        Prints a message without moving to the next line.
+
+        Parameters
+        ----------
+        message : str
+            The message to print.
+        """
+        pass
+
+    @abstractmethod
+    def writeLine(self, message: str) -> None:
+        """
+        Prints a message and moves to the next line.
+
+        Parameters
+        ----------
+        message : str
+            The message to print.
+        """
+        pass
+
+    @abstractmethod
+    def ask(self, question: str) -> str:
+        """
+        Prompts the user for input with a message and returns the user's response.
+
+        Parameters
+        ----------
+        question : str
+            The question to ask the user.
+
+        Returns
+        -------
+        str
+            The user's input, as a string.
+        """
+        pass
+
+    @abstractmethod
+    def confirm(self, question: str, default: bool = False) -> bool:
+        """
+        Asks a confirmation question and returns True or False based on the user's response.
+
+        Parameters
+        ----------
+        question : str
+            The confirmation question to ask.
+        default : bool, optional
+            The default response if the user presses Enter without typing a response.
+            Default is False, which corresponds to a 'No' response.
+
+        Returns
+        -------
+        bool
+            The user's response, which will be True if 'Y' is entered,
+            or False if 'N' is entered or the default is used.
+        """
+        pass
+
+    @abstractmethod
+    def secret(self, question: str) -> str:
+        """
+        Prompts the user for hidden input, typically used for password input.
+
+        Parameters
+        ----------
+        question : str
+            The prompt to ask the user.
+
+        Returns
+        -------
+        str
+            The user's hidden input, returned as a string.
+        """
+        pass
+
+    @abstractmethod
+    def table(self, headers: List[str], rows: List[List[str]]) -> None:
+        """
+        Prints a table in the console with the given headers and rows, with bold headers.
+
+        Parameters
+        ----------
+        headers : List[str]
+            The column headers for the table.
+        rows : List[List[str]]
+            The rows of the table, where each row is a list of strings representing the columns.
+
+        Raises
+        ------
+        ValueError
+            If headers or rows are empty.
+
+        Notes
+        -----
+        The table adjusts column widths dynamically, includes bold headers, and uses box-drawing characters for formatting.
+        """
+        pass
+
+    @abstractmethod
+    def anticipate(self, question: str, options: List[str], default: Optional[str] = None) -> str:
+        """
+        Provides autocomplete suggestions based on user input.
+
+        Parameters
+        ----------
+        question : str
+            The prompt for the user.
+        options : List[str]
+            The list of possible options for autocomplete.
+        default : Optional[str], optional
+            The default value if no matching option is found. Defaults to None.
+
+        Returns
+        -------
+        str
+            The chosen option or the default value.
+
+        Notes
+        -----
+        This method allows the user to input a string, and then attempts to provide
+        an autocomplete suggestion by matching the beginning of the input with the
+        available options. If no match is found, the method returns the default value
+        or the user input if no default is provided.
+        """
+        pass
+
+    @abstractmethod
+    def choice(self, question: str, choices: List[str], default_index: int = 0) -> str:
+        """
+        Allows the user to select an option from a list.
+
+        Parameters
+        ----------
+        question : str
+            The prompt for the user.
+        choices : List[str]
+            The list of available choices.
+        default_index : int, optional
+            The index of the default choice (zero-based). Defaults to 0.
+
+        Returns
+        -------
+        str
+            The selected choice.
+
+        Raises
+        ------
+        ValueError
+            If `default_index` is out of the range of choices.
+
+        Notes
+        -----
+        The user is presented with a numbered list of choices and prompted to select
+        one by entering the corresponding number. If an invalid input is provided,
+        the user will be repeatedly prompted until a valid choice is made.
+        """
+        pass
+
+    @abstractmethod
+    def exception(self, e: Exception) -> None:
+        """
+        Prints an exception message with detailed information.
+
+        Parameters
+        ----------
+        e : Exception
+            The exception to print.
+
+        Notes
+        -----
+        This method prints the exception type, message, and a detailed stack trace.
+        """
+        pass
+
+    @abstractmethod
+    def exitSuccess(self, message: Optional[str] = None) -> None:
+        """
+        Exits the program with a success message.
+
+        Parameters
+        ----------
+        message : Optional[str], optional
+            The success message to print before exiting.
+        """
+        pass
+
+    @abstractmethod
+    def exitError(self, message: Optional[str] = None) -> None:
+        """
+        Exits the program with an error message.
+
+        Parameters
+        ----------
+        message : Optional[str], optional
+            The error message to print before exiting.
+        """
+        pass

orionis/console/output/enums/__init__.py

@@ -0,0 +1,5 @@
+from .styles import ANSIColors
+
+__all__ = [
+    "ANSIColors"
+]

orionis/foundation/application.py

@@ -1,6 +1,7 @@
 from typing import Type, List
 from orionis.container.container import Container
 from orionis.container.contracts.service_provider import IServiceProvider
+from orionis.foundation.providers.dumper_provider import DebugProvider
 
 class App(Container):
     """
@@ -98,7 +99,7 @@ class App(Container):
         before user-defined providers are loaded.
         """
         core_providers = [
-            #...
+            DebugProvider
         ]
 
         for provider_cls in core_providers:

orionis/foundation/providers/console_provider.py

@@ -0,0 +1,21 @@
+from orionis.console.output.console import Console
+from orionis.console.output.contracts.console import IConsole
+from orionis.container.providers.service_provider import ServiceProvider
+
+class ConsoleProvider(ServiceProvider):
+    """
+    Debug provider for the Orionis framework.
+    This provider is responsible for debugging functionalities.
+    """
+
+    def register(self) -> None:
+        """
+        Register services into the application container.
+        """
+        self.app.transient(IConsole, Console, alias="console")
+
+    def boot(self) -> None:
+        """
+        Perform any post-registration bootstrapping or initialization.
+        """
+        pass

orionis/foundation/providers/dumper_provider.py

@@ -0,0 +1,21 @@
+from orionis._console.dumper.dump_die import Debug
+from orionis.console.dumper.contracts.dump import IDebug
+from orionis.container.providers.service_provider import ServiceProvider
+
+class DumperProvider(ServiceProvider):
+    """
+    Debug provider for the Orionis framework.
+    This provider is responsible for debugging functionalities.
+    """
+
+    def register(self) -> None:
+        """
+        Register services into the application container.
+        """
+        self.app.transient(IDebug, Debug, alias="dumper")
+
+    def boot(self) -> None:
+        """
+        Perform any post-registration bootstrapping or initialization.
+        """
+        pass

orionis/foundation/providers/progress_bar_provider.py

@@ -0,0 +1,21 @@
+from orionis.console.dynamic.contracts.progress_bar import IProgressBar
+from orionis.console.dynamic.progress_bar import ProgressBar
+from orionis.container.providers.service_provider import ServiceProvider
+
+class ProgressBarProvider(ServiceProvider):
+    """
+    Debug provider for the Orionis framework.
+    This provider is responsible for debugging functionalities.
+    """
+
+    def register(self) -> None:
+        """
+        Register services into the application container.
+        """
+        self.app.transient(IProgressBar, ProgressBar, alias="progress_bar")
+
+    def boot(self) -> None:
+        """
+        Perform any post-registration bootstrapping or initialization.
+        """
+        pass

orionis/metadata/framework.py

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

orionis/services/environment/core/dot_env.py

@@ -5,7 +5,7 @@ import threading
 from pathlib import Path
 from typing import Any, Optional, Union
 from dotenv import dotenv_values, load_dotenv, set_key, unset_key
-from orionis.patterns.singleton.meta import Singleton
+from orionis.support.patterns.singleton import Singleton
 from orionis.services.environment.exceptions import OrionisEnvironmentValueException, OrionisEnvironmentValueError
 from orionis.services.environment.dynamic.types import EnvTypes
 

orionis/services/paths/contracts/resolver.py

@@ -55,13 +55,13 @@ class IResolver(ABC):
         pass
 
     @abstractmethod
-    def __str__(self) -> str:
+    def get(self):
         """
-        Returns the resolved path as a string (for print or str()).
+        Returns the resolved path as a Path object.
 
         Returns
         -------
-        str
+        Path
             The resolved path.
         """
-        pass
+        pass

orionis/services/paths/resolver.py

@@ -75,6 +75,17 @@ class Resolver(IResolver):
         """
         return str(self.resolved_path)
 
+    def get(self) -> Path:
+        """
+        Returns the resolved path as a Path object.
+
+        Returns
+        -------
+        Path
+            The resolved path.
+        """
+        return self.resolved_path
+
     def __str__(self) -> str:
         """
         Returns the string representation of the resolved path.

orionis/support/facades/console.py

@@ -0,0 +1,15 @@
+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 "console"

orionis/support/facades/dumper.py

@@ -0,0 +1,15 @@
+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 "dumper"

orionis/support/facades/progress_bar.py

@@ -0,0 +1,15 @@
+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 "progress_bar"

orionis/{services → support}/formatter/exceptions/parser.py

@@ -1,6 +1,6 @@
 import traceback
 from typing import Any, Dict, List, Optional, Union
-from orionis.services.formatter.exceptions.contracts.parser import IExceptionParser
+from orionis.support.formatter.exceptions.contracts.parser import IExceptionParser
 
 class ExceptionParser(IExceptionParser):
     """

orionis/{services → support}/formatter/serializer.py

@@ -1,4 +1,4 @@
-from orionis.services.formatter.exceptions.parser import ExceptionParser
+from orionis.support.formatter.exceptions.parser import ExceptionParser
 
 class Parser:
 

orionis/support/patterns/singleton/__init__.py

@@ -0,0 +1,5 @@
+from .meta import Singleton
+
+__all__ = [
+    "Singleton"
+]

orionis/test/output/dumper.py

@@ -71,7 +71,7 @@ class TestDumper(ITestDumper):
         original_stderr = sys.stderr
 
         try:
-            from orionis.console.dumper.dump_die import Debug
+            from orionis._console.dumper.dump_die import Debug
 
             sys.stdout = sys.__stdout__
             sys.stderr = sys.__stderr__
@@ -110,7 +110,7 @@ class TestDumper(ITestDumper):
         original_stderr = sys.stderr
 
         try:
-            from orionis.console.dumper.dump_die import Debug
+            from orionis._console.dumper.dump_die import Debug
 
             sys.stdout = sys.__stdout__
             sys.stderr = sys.__stderr__