orionis 0.197.0__py3-none-any.whl → 0.198.0__py3-none-any.whl

orionis/framework.py

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

orionis/luminate/application.py

@@ -23,15 +23,15 @@ class Application(metaclass=SingletonMeta):
     ----------
     _booted : bool
         Indicates whether the application has been booted.
-    _custom_providers : List[Type[ServiceProvider]]
+    _custom_providers : List[Type[IServiceProvider]]
         Custom service providers defined by the developer.
-    _service_providers : List[Type[ServiceProvider]]
+    _service_providers : List[Type[IServiceProvider]]
         Core application service providers.
-    _config : dict
+    _config : Dict
         Configuration settings of the application.
-    _commands : dict
+    _commands : Dict
         Registered console commands.
-    _env : dict
+    _env : Dict
         Environment variables.
     _container : IContainer
         The service container instance.
@@ -41,8 +41,17 @@ class Application(metaclass=SingletonMeta):
 
     def __init__(self):
         """
-        Initializes the application by setting up service providers, environment variables,
-        configuration, and the service container.
+        Initializes the application by setting up the service container and preparing
+        lists for custom service providers, service providers, configuration, commands,
+        and environment variables.
+        Attributes:
+            _custom_providers (List[Type[IServiceProvider]]): List to store custom service providers.
+            _service_providers (List[Type[IServiceProvider]]): List to store service providers.
+            _config (Dict): Dictionary to store configuration settings.
+            _commands (Dict): Dictionary to store commands.
+            _env (Dict): Dictionary to store environment variables.
+            _container (IContainer): The service container instance.
+        Registers the application instance in the service container.
         """
         self._custom_providers: List[Type[IServiceProvider]] = []
         self._service_providers: List[Type[IServiceProvider]] = []
@@ -57,7 +66,7 @@ class Application(metaclass=SingletonMeta):
     @classmethod
     def boot(cls) -> None:
         """
-        Marks the application as booted.
+        Marks the application as booted by setting the _booted class attribute to True.
         """
         cls._booted = True
 
@@ -69,7 +78,7 @@ class Application(metaclass=SingletonMeta):
         Returns
         -------
         bool
-            True if the application is running, otherwise False.
+            True if the application has been booted, otherwise False.
         """
         return cls._booted
 
@@ -86,28 +95,38 @@ class Application(metaclass=SingletonMeta):
         Raises
         ------
         RuntimeError
-            If the application has not been initialized yet.
+            If the application instance does not exist.
         """
         if cls not in SingletonMeta._instances:
-            raise RuntimeError("Application has not been initialized yet. Please create an instance first.")
+            raise RuntimeError("Application instance does not exist. Please create an instance first.")
         return SingletonMeta._instances[cls]
 
     @classmethod
     def destroy(cls) -> None:
         """
-        Destroys the singleton instance of the Application.
+        Destroys the singleton instance of the application if it exists.
+
+        This method checks if the class has an instance in the SingletonMeta
+        instances dictionary and deletes it if found.
+
+        Returns
+        -------
+        None
         """
         if cls in SingletonMeta._instances:
             del SingletonMeta._instances[cls]
 
     def withProviders(self, providers: List[Type[IServiceProvider]] = None) -> "Application":
         """
-        Sets custom service providers.
-
-        Parameters
-        ----------
-        providers : List[Type[IServiceProvider]], optional
-            List of service providers, by default None.
+        This method allows you to specify a list of custom service providers
+        that will be used by the application. If no providers are specified,
+        an empty list will be used by default.
+            A list of service provider classes to be used by the application.
+            If not provided, defaults to an empty list.
+        Returns
+        -------
+        Application
+            The instance of the Application with the custom service providers set.
         """
         self._custom_providers = providers or []
         return self
@@ -125,25 +144,30 @@ class Application(metaclass=SingletonMeta):
 
     def create(self) -> None:
         """
-        Initializes and boots the application, including loading commands
-        and service providers.
+        Initializes and boots the application.
+        This method performs the following steps:
+        1. Boots the application by calling the `_bootstrapping` method.
+        2. Loads commands and service providers by calling the `_loadCommands` method.
+        3. Boots service providers asynchronously using `AsyncExecutor.run` on the `_bootServiceProviders` method.
+        4. Changes the application status to booted by calling `Application.boot`.
+        Returns
+        -------
+        None
         """
-
-        # Boot the application
         self._bootstrapping()
-
-        # Load commands and service providers
         self._loadCommands()
-
-        # Boot service providers
         AsyncExecutor.run(self._bootServiceProviders())
-
-        # Change the application status to booted
         Application.boot()
 
     async def _bootServiceProviders(self) -> None:
         """
-        Boots all registered service providers.
+        This method iterates over all registered service providers, registers them,
+        and calls their `boot` method if it exists and is callable.
+        Raises
+        ------
+        RuntimeError
+            If an error occurs while booting a service provider, a RuntimeError is raised
+            with a message indicating which service provider failed and the original exception.
         """
         for service in self._service_providers:
             provider: IServiceProvider = service(app=self._container)
@@ -157,8 +181,16 @@ class Application(metaclass=SingletonMeta):
 
     def _bootstrapping(self) -> None:
         """
-        Loads essential components such as environment variables,
-        configurations, commands, and service providers.
+        Initializes and loads essential components for the application.
+        This method sets up the environment variables, configurations, commands,
+        and service providers by utilizing their respective bootstrappers. It
+        iterates through a list of bootstrappers, updating or extending the
+        corresponding properties with the data provided by each bootstrapper.
+        Raises
+        ------
+        BootstrapRuntimeError
+            If an error occurs during the bootstrapping process, an exception is
+            raised with details about the specific bootstrapper that failed.
         """
         bootstrappers = [
             {'property': self._env, 'instance': EnvironmentBootstrapper()},
@@ -182,7 +214,18 @@ class Application(metaclass=SingletonMeta):
 
     def _loadCommands(self) -> None:
         """
-        Registers application commands in the service container.
+        This method iterates over the `_commands` dictionary and registers each command
+        in the service container as a transient service. The command's signature and
+        concrete implementation are retrieved from the dictionary and passed to the
+        container's `transient` method.
+
+        Parameters
+        ----------
+        None
+
+        Returns
+        -------
+        None
         """
         for command, data_command in self._commands.items():
             self._container.transient(data_command.get('signature'), data_command.get('concrete'))

{orionis-0.197.0.dist-info → orionis-0.198.0.dist-info}/METADATA

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

{orionis-0.197.0.dist-info → orionis-0.198.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 orionis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/console.py,sha256=4gYWxf0fWYgJ4RKwARvnTPh06FL3GJ6SAZ7R2NzOICw,1342
-orionis/framework.py,sha256=qRf3MBqE0BJyfxQWiCeS5RknzvE007hmit6b1ki-WsU,1469
+orionis/framework.py,sha256=SNv_C3vMiGA9gfXNiAV_N1H4a4Ib7DNhq64blJGNTuM,1469
 orionis/installer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/installer/manager.py,sha256=Li4TVziRXWfum02xNG4JHwbnLk-u8xzHjdqKz-D894k,2755
 orionis/installer/output.py,sha256=7O9qa2xtXMB_4ZvVi-Klneom9YazwygAd_4uYAoxhbU,8548
@@ -10,7 +10,7 @@ orionis/installer/contracts/manager.py,sha256=Zfndhuyu0JaTKo3PsGsKmVsvotQMw8Pmt4
 orionis/installer/contracts/output.py,sha256=t1KLw610-hHy63UbFFE2BYwWHWRbW8_ofuEvRLx_IUE,983
 orionis/installer/contracts/setup.py,sha256=aWYkCv-z48bXXZynYapc3uMIE1gyO6XnkTw3b4MTBq4,784
 orionis/luminate/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-orionis/luminate/application.py,sha256=AzVepXMIzA23NMWMCzZw9F-B-XIV4ik8aZA5rcPBsbE,6966
+orionis/luminate/application.py,sha256=bpZeV8NEHLNm8MkS6suCX3nd7LYB4dOTIgaIivKl2xI,9526
 orionis/luminate/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/luminate/config/app.py,sha256=7teuVPuaV2ao0M5Bv-jhSgjEwb9DtVwde2saTRmYru4,1737
 orionis/luminate/config/auth.py,sha256=CG8F0pfVjKz4DY3d1Wi7gscdhnp4TT-Q8SJ2sdsHh18,523
@@ -181,9 +181,9 @@ tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/tools/class_example.py,sha256=dIPD997Y15n6WmKhWoOFSwEldRm9MdOHTZZ49eF1p3c,1056
 tests/tools/test_reflection.py,sha256=bhLQ7VGVod4B8sv-rW9AjnOumvaBVsoxieA3sdoM2yM,5244
-orionis-0.197.0.dist-info/LICENCE,sha256=-_4cF2EBKuYVS_SQpy1uapq0oJPUU1vl_RUWSy2jJTo,1111
-orionis-0.197.0.dist-info/METADATA,sha256=SiKzS2G5mQZoaRMQ0ByvKZ4DRcVmvBMrE15rBcmg1HQ,3003
-orionis-0.197.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-orionis-0.197.0.dist-info/entry_points.txt,sha256=a_e0faeSqyUCVZd0MqljQ2oaHHdlsz6g9sU_bMqi5zQ,49
-orionis-0.197.0.dist-info/top_level.txt,sha256=2bdoHgyGZhOtLAXS6Om8OCTmL24dUMC_L1quMe_ETbk,14
-orionis-0.197.0.dist-info/RECORD,,
+orionis-0.198.0.dist-info/LICENCE,sha256=-_4cF2EBKuYVS_SQpy1uapq0oJPUU1vl_RUWSy2jJTo,1111
+orionis-0.198.0.dist-info/METADATA,sha256=ZnVjxNFfxxQL4cjfoNa9vYE5AymnYuB2I5Q7lFJMebU,3003
+orionis-0.198.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+orionis-0.198.0.dist-info/entry_points.txt,sha256=a_e0faeSqyUCVZd0MqljQ2oaHHdlsz6g9sU_bMqi5zQ,49
+orionis-0.198.0.dist-info/top_level.txt,sha256=2bdoHgyGZhOtLAXS6Om8OCTmL24dUMC_L1quMe_ETbk,14
+orionis-0.198.0.dist-info/RECORD,,