Added cpl-mail
This commit is contained in:
@@ -35,7 +35,7 @@ You can define custom schematics by creating templates in a ```.cpl``` folder.
|
||||
| ```enum``` | Enum class | ```<name>``` |
|
||||
| ```pipe``` | Pipe class | ```<name>``` |
|
||||
| ```service``` | Service class | ```<name>``` |
|
||||
| ```settings``` | [Configmodel](cpl_core.configuration) | ```<name>``` |
|
||||
| ```settings``` | [Configmodel](cpl.core.configuration) | ```<name>``` |
|
||||
| ```test``` | Test class | ```<name>``` |
|
||||
| ```thread``` | Thread class | ```<name>``` |
|
||||
| ```validator``` | Validator class | ```<name>``` |
|
||||
|
||||
@@ -15,7 +15,7 @@ cpl **P**
|
||||
|
||||
The command can be used to publish a project of type "console" or "library".
|
||||
|
||||
The publish command builds the source files and then creates an ```setup.py``` with data from ```cpl_core.json```.
|
||||
The publish command builds the source files and then creates an ```setup.py``` with data from ```cpl.core.json```.
|
||||
The command executes the ```setup.py``` and removes all source files with the ```setup.py``` from the 'publish/' directory.
|
||||
|
||||
Generated files of ```setup.py``` are in the 'publish/setup/' directory.
|
||||
|
||||
@@ -7,7 +7,7 @@ Submodules
|
||||
cpl\_core.application.application\_abc module
|
||||
---------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.application.application_abc
|
||||
.. automodule:: cpl.core.application.application_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -15,7 +15,7 @@ cpl\_core.application.application\_abc module
|
||||
cpl\_core.application.application\_builder module
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.application.application_builder
|
||||
.. automodule:: cpl.core.application.application_builder
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -23,7 +23,7 @@ cpl\_core.application.application\_builder module
|
||||
cpl\_core.application.application\_builder\_abc module
|
||||
------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.application.application_builder_abc
|
||||
.. automodule:: cpl.core.application.application_builder_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -31,7 +31,7 @@ cpl\_core.application.application\_builder\_abc module
|
||||
cpl\_core.application.application\_extension\_abc module
|
||||
--------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.application.application_extension_abc
|
||||
.. automodule:: cpl.core.application.application_extension_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -39,7 +39,7 @@ cpl\_core.application.application\_extension\_abc module
|
||||
cpl\_core.application.startup\_abc module
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.application.startup_abc
|
||||
.. automodule:: cpl.core.application.startup_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -47,7 +47,7 @@ cpl\_core.application.startup\_abc module
|
||||
cpl\_core.application.startup\_extension\_abc module
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.application.startup_extension_abc
|
||||
.. automodule:: cpl.core.application.startup_extension_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -55,7 +55,7 @@ cpl\_core.application.startup\_extension\_abc module
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_core.application
|
||||
.. automodule:: cpl.core.application
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
@@ -7,7 +7,7 @@ Submodules
|
||||
cpl\_core.configuration.argument\_abc module
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.configuration.argument_abc
|
||||
.. automodule:: cpl.core.configuration.argument_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -15,7 +15,7 @@ cpl\_core.configuration.argument\_abc module
|
||||
cpl\_core.configuration.argument\_builder module
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.configuration.argument_builder
|
||||
.. automodule:: cpl.core.configuration.argument_builder
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -23,7 +23,7 @@ cpl\_core.configuration.argument\_builder module
|
||||
cpl\_core.configuration.argument\_executable\_abc module
|
||||
--------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.configuration.argument_executable_abc
|
||||
.. automodule:: cpl.core.configuration.argument_executable_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -31,7 +31,7 @@ cpl\_core.configuration.argument\_executable\_abc module
|
||||
cpl\_core.configuration.argument\_type\_enum module
|
||||
---------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.configuration.argument_type_enum
|
||||
.. automodule:: cpl.core.configuration.argument_type_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -39,7 +39,7 @@ cpl\_core.configuration.argument\_type\_enum module
|
||||
cpl\_core.configuration.configuration module
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.configuration.configuration
|
||||
.. automodule:: cpl.core.configuration.configuration
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -47,7 +47,7 @@ cpl\_core.configuration.configuration module
|
||||
cpl\_core.configuration.configuration\_abc module
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.configuration.configuration_abc
|
||||
.. automodule:: cpl.core.configuration.configuration_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -55,7 +55,7 @@ cpl\_core.configuration.configuration\_abc module
|
||||
cpl\_core.configuration.configuration\_model\_abc module
|
||||
--------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.configuration.configuration_model_abc
|
||||
.. automodule:: cpl.core.configuration.configuration_model_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -63,7 +63,7 @@ cpl\_core.configuration.configuration\_model\_abc module
|
||||
cpl\_core.configuration.configuration\_variable\_name\_enum module
|
||||
------------------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.configuration.configuration_variable_name_enum
|
||||
.. automodule:: cpl.core.configuration.configuration_variable_name_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -71,7 +71,7 @@ cpl\_core.configuration.configuration\_variable\_name\_enum module
|
||||
cpl\_core.configuration.executable\_argument module
|
||||
---------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.configuration.executable_argument
|
||||
.. automodule:: cpl.core.configuration.executable_argument
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -79,7 +79,7 @@ cpl\_core.configuration.executable\_argument module
|
||||
cpl\_core.configuration.flag\_argument module
|
||||
---------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.configuration.flag_argument
|
||||
.. automodule:: cpl.core.configuration.flag_argument
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -87,7 +87,7 @@ cpl\_core.configuration.flag\_argument module
|
||||
cpl\_core.configuration.validator\_abc module
|
||||
---------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.configuration.validator_abc
|
||||
.. automodule:: cpl.core.configuration.validator_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -95,7 +95,7 @@ cpl\_core.configuration.validator\_abc module
|
||||
cpl\_core.configuration.variable\_argument module
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.configuration.variable_argument
|
||||
.. automodule:: cpl.core.configuration.variable_argument
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -103,7 +103,7 @@ cpl\_core.configuration.variable\_argument module
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_core.configuration
|
||||
.. automodule:: cpl.core.configuration
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
@@ -7,7 +7,7 @@ Submodules
|
||||
cpl\_core.console.background\_color\_enum module
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.console.background_color_enum
|
||||
.. automodule:: cpl.core.console.background_color_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -15,7 +15,7 @@ cpl\_core.console.background\_color\_enum module
|
||||
cpl\_core.console.console module
|
||||
--------------------------------
|
||||
|
||||
.. automodule:: cpl_core.console.console
|
||||
.. automodule:: cpl.core.console.console
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -23,7 +23,7 @@ cpl\_core.console.console module
|
||||
cpl\_core.console.console\_call module
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.console.console_call
|
||||
.. automodule:: cpl.core.console.console_call
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -31,7 +31,7 @@ cpl\_core.console.console\_call module
|
||||
cpl\_core.console.foreground\_color\_enum module
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.console.foreground_color_enum
|
||||
.. automodule:: cpl.core.console.foreground_color_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -39,7 +39,7 @@ cpl\_core.console.foreground\_color\_enum module
|
||||
cpl\_core.console.spinner\_thread module
|
||||
----------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.console.spinner_thread
|
||||
.. automodule:: cpl.core.console.spinner_thread
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -47,7 +47,7 @@ cpl\_core.console.spinner\_thread module
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_core.console
|
||||
.. automodule:: cpl.core.console
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
@@ -7,7 +7,7 @@ Submodules
|
||||
cpl\_core.database.connection.database\_connection module
|
||||
---------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.database.connection.database_connection
|
||||
.. automodule:: cpl.core.database.connection.database_connection
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -15,7 +15,7 @@ cpl\_core.database.connection.database\_connection module
|
||||
cpl\_core.database.connection.database\_connection\_abc module
|
||||
--------------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.database.connection.database_connection_abc
|
||||
.. automodule:: cpl.core.database.connection.database_connection_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -23,7 +23,7 @@ cpl\_core.database.connection.database\_connection\_abc module
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_core.database.connection
|
||||
.. automodule:: cpl.core.database.connection
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
@@ -7,7 +7,7 @@ Submodules
|
||||
cpl\_core.database.context.database\_context module
|
||||
---------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.database.context.database_context
|
||||
.. automodule:: cpl.core.database.context.database_context
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -15,7 +15,7 @@ cpl\_core.database.context.database\_context module
|
||||
cpl\_core.database.context.database\_context\_abc module
|
||||
--------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.database.context.database_context_abc
|
||||
.. automodule:: cpl.core.database.context.database_context_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -23,7 +23,7 @@ cpl\_core.database.context.database\_context\_abc module
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_core.database.context
|
||||
.. automodule:: cpl.core.database.context
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
@@ -7,8 +7,8 @@ Subpackages
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
cpl_core.database.connection
|
||||
cpl_core.database.context
|
||||
cpl.core.database.connection
|
||||
cpl.core.database.context
|
||||
|
||||
Submodules
|
||||
----------
|
||||
@@ -16,7 +16,7 @@ Submodules
|
||||
cpl\_core.database.database\_settings module
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.database.database_settings
|
||||
.. automodule:: cpl.core.database.database_settings
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -24,7 +24,7 @@ cpl\_core.database.database\_settings module
|
||||
cpl\_core.database.database\_settings\_name\_enum module
|
||||
--------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.database.database_settings_name_enum
|
||||
.. automodule:: cpl.core.database.database_settings_name_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -32,7 +32,7 @@ cpl\_core.database.database\_settings\_name\_enum module
|
||||
cpl\_core.database.table\_abc module
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.database.table_abc
|
||||
.. automodule:: cpl.core.database.table_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -40,7 +40,7 @@ cpl\_core.database.table\_abc module
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_core.database
|
||||
.. automodule:: cpl.core.database
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
@@ -7,7 +7,7 @@ Submodules
|
||||
cpl\_core.dependency\_injection.scope module
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.dependency_injection.scope
|
||||
.. automodule:: cpl.core.dependency_injection.scope
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -15,7 +15,7 @@ cpl\_core.dependency\_injection.scope module
|
||||
cpl\_core.dependency\_injection.scope\_abc module
|
||||
-------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.dependency_injection.scope_abc
|
||||
.. automodule:: cpl.core.dependency_injection.scope_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -23,7 +23,7 @@ cpl\_core.dependency\_injection.scope\_abc module
|
||||
cpl\_core.dependency\_injection.scope\_builder module
|
||||
-----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.dependency_injection.scope_builder
|
||||
.. automodule:: cpl.core.dependency_injection.scope_builder
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -31,7 +31,7 @@ cpl\_core.dependency\_injection.scope\_builder module
|
||||
cpl\_core.dependency\_injection.service\_collection module
|
||||
----------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.dependency_injection.service_collection
|
||||
.. automodule:: cpl.core.dependency_injection.service_collection
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -39,7 +39,7 @@ cpl\_core.dependency\_injection.service\_collection module
|
||||
cpl\_core.dependency\_injection.service\_collection\_abc module
|
||||
---------------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.dependency_injection.service_collection_abc
|
||||
.. automodule:: cpl.core.dependency_injection.service_collection_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -47,7 +47,7 @@ cpl\_core.dependency\_injection.service\_collection\_abc module
|
||||
cpl\_core.dependency\_injection.service\_descriptor module
|
||||
----------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.dependency_injection.service_descriptor
|
||||
.. automodule:: cpl.core.dependency_injection.service_descriptor
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -55,7 +55,7 @@ cpl\_core.dependency\_injection.service\_descriptor module
|
||||
cpl\_core.dependency\_injection.service\_lifetime\_enum module
|
||||
--------------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.dependency_injection.service_lifetime_enum
|
||||
.. automodule:: cpl.core.dependency_injection.service_lifetime_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -63,7 +63,7 @@ cpl\_core.dependency\_injection.service\_lifetime\_enum module
|
||||
cpl\_core.dependency\_injection.service\_provider module
|
||||
--------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.dependency_injection.service_provider
|
||||
.. automodule:: cpl.core.dependency_injection.service_provider
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -71,7 +71,7 @@ cpl\_core.dependency\_injection.service\_provider module
|
||||
cpl\_core.dependency\_injection.service\_provider\_abc module
|
||||
-------------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.dependency_injection.service_provider_abc
|
||||
.. automodule:: cpl.core.dependency_injection.service_provider_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -79,7 +79,7 @@ cpl\_core.dependency\_injection.service\_provider\_abc module
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_core.dependency_injection
|
||||
.. automodule:: cpl.core.dependency_injection
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
@@ -7,7 +7,7 @@ Submodules
|
||||
cpl\_core.environment.application\_environment module
|
||||
-----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.environment.application_environment
|
||||
.. automodule:: cpl.core.environment.application_environment
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -15,7 +15,7 @@ cpl\_core.environment.application\_environment module
|
||||
cpl\_core.environment.application\_environment\_abc module
|
||||
----------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.environment.application_environment_abc
|
||||
.. automodule:: cpl.core.environment.application_environment_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -23,7 +23,7 @@ cpl\_core.environment.application\_environment\_abc module
|
||||
cpl\_core.environment.environment\_name\_enum module
|
||||
----------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.environment.environment_name_enum
|
||||
.. automodule:: cpl.core.environment.environment_name_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -31,7 +31,7 @@ cpl\_core.environment.environment\_name\_enum module
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_core.environment
|
||||
.. automodule:: cpl.core.environment
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
@@ -7,7 +7,7 @@ Submodules
|
||||
cpl\_core.logging.logger\_abc module
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.log.logger_abc
|
||||
.. automodule:: cpl.core.log.logger_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -15,7 +15,7 @@ cpl\_core.logging.logger\_abc module
|
||||
cpl\_core.logging.logger\_service module
|
||||
----------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.log.logger_service
|
||||
.. automodule:: cpl.core.log.logger_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -23,7 +23,7 @@ cpl\_core.logging.logger\_service module
|
||||
cpl\_core.logging.logging\_level\_enum module
|
||||
---------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.log.logging_level_enum
|
||||
.. automodule:: cpl.core.log.logging_level_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -31,7 +31,7 @@ cpl\_core.logging.logging\_level\_enum module
|
||||
cpl\_core.logging.logging\_settings module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.log.logging_settings
|
||||
.. automodule:: cpl.core.log.logging_settings
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -39,7 +39,7 @@ cpl\_core.logging.logging\_settings module
|
||||
cpl\_core.logging.logging\_settings\_name\_enum module
|
||||
------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.log.logging_settings_name_enum
|
||||
.. automodule:: cpl.core.log.logging_settings_name_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -47,7 +47,7 @@ cpl\_core.logging.logging\_settings\_name\_enum module
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_core.log
|
||||
.. automodule:: cpl.core.log
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
@@ -7,7 +7,7 @@ Submodules
|
||||
cpl\_core.mailing.email module
|
||||
------------------------------
|
||||
|
||||
.. automodule:: cpl_mail.email
|
||||
.. automodule:: cpl.mail.email
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -15,7 +15,7 @@ cpl\_core.mailing.email module
|
||||
cpl\_core.mailing.email\_client\_abc module
|
||||
-------------------------------------------
|
||||
|
||||
.. automodule:: cpl_mail.email_client_abc
|
||||
.. automodule:: cpl.mail.email_client_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -23,7 +23,7 @@ cpl\_core.mailing.email\_client\_abc module
|
||||
cpl\_core.mailing.email\_client\_service module
|
||||
-----------------------------------------------
|
||||
|
||||
.. automodule:: cpl_mail.email_client_service
|
||||
.. automodule:: cpl.mail.email_client_service
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -31,7 +31,7 @@ cpl\_core.mailing.email\_client\_service module
|
||||
cpl\_core.mailing.email\_client\_settings module
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_mail.email_client_settings
|
||||
.. automodule:: cpl.mail.email_client_settings
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -39,7 +39,7 @@ cpl\_core.mailing.email\_client\_settings module
|
||||
cpl\_core.mailing.email\_client\_settings\_name\_enum module
|
||||
------------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_mail.email_client_settings_name_enum
|
||||
.. automodule:: cpl.mail.email_client_settings_name_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -47,7 +47,7 @@ cpl\_core.mailing.email\_client\_settings\_name\_enum module
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_mail
|
||||
.. automodule:: cpl.mail
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
18
docs/build/html/_sources/cpl_core.pipes.rst.txt
vendored
18
docs/build/html/_sources/cpl_core.pipes.rst.txt
vendored
@@ -7,7 +7,7 @@ Submodules
|
||||
cpl\_core.pipes.bool\_pipe module
|
||||
---------------------------------
|
||||
|
||||
.. automodule:: cpl_core.pipes.bool_pipe
|
||||
.. automodule:: cpl.core.pipes.bool_pipe
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -15,7 +15,7 @@ cpl\_core.pipes.bool\_pipe module
|
||||
cpl\_core.pipes.first\_char\_to\_lower\_pipe module
|
||||
---------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.pipes.first_char_to_lower_pipe
|
||||
.. automodule:: cpl.core.pipes.first_char_to_lower_pipe
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -23,7 +23,7 @@ cpl\_core.pipes.first\_char\_to\_lower\_pipe module
|
||||
cpl\_core.pipes.first\_to\_upper\_pipe module
|
||||
---------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.pipes.first_to_upper_pipe
|
||||
.. automodule:: cpl.core.pipes.first_to_upper_pipe
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -31,7 +31,7 @@ cpl\_core.pipes.first\_to\_upper\_pipe module
|
||||
cpl\_core.pipes.ip\_address\_pipe module
|
||||
----------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.pipes.ip_address_pipe
|
||||
.. automodule:: cpl.core.pipes.ip_address_pipe
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -39,7 +39,7 @@ cpl\_core.pipes.ip\_address\_pipe module
|
||||
cpl\_core.pipes.pipe\_abc module
|
||||
--------------------------------
|
||||
|
||||
.. automodule:: cpl_core.pipes.pipe_abc
|
||||
.. automodule:: cpl.core.pipes.pipe_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -47,7 +47,7 @@ cpl\_core.pipes.pipe\_abc module
|
||||
cpl\_core.pipes.to\_camel\_case\_pipe module
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.pipes.to_camel_case_pipe
|
||||
.. automodule:: cpl.core.pipes.to_camel_case_pipe
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -55,7 +55,7 @@ cpl\_core.pipes.to\_camel\_case\_pipe module
|
||||
cpl\_core.pipes.to\_snake\_case\_pipe module
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.pipes.to_snake_case_pipe
|
||||
.. automodule:: cpl.core.pipes.to_snake_case_pipe
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -63,7 +63,7 @@ cpl\_core.pipes.to\_snake\_case\_pipe module
|
||||
cpl\_core.pipes.version\_pipe module
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.pipes.version_pipe
|
||||
.. automodule:: cpl.core.pipes.version_pipe
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -71,7 +71,7 @@ cpl\_core.pipes.version\_pipe module
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_core.pipes
|
||||
.. automodule:: cpl.core.pipes
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
22
docs/build/html/_sources/cpl_core.rst.txt
vendored
22
docs/build/html/_sources/cpl_core.rst.txt
vendored
@@ -4,15 +4,15 @@ API reference
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
cpl_core.application
|
||||
cpl_core.configuration
|
||||
cpl_core.console
|
||||
cpl_core.database
|
||||
cpl_core.dependency_injection
|
||||
cpl_core.environment
|
||||
cpl_core.log
|
||||
cpl_mail
|
||||
cpl_core.pipes
|
||||
cpl_core.time
|
||||
cpl_core.utils
|
||||
cpl.core.application
|
||||
cpl.core.configuration
|
||||
cpl.core.console
|
||||
cpl.core.database
|
||||
cpl.core.dependency_injection
|
||||
cpl.core.environment
|
||||
cpl.core.log
|
||||
cpl.mail
|
||||
cpl.core.pipes
|
||||
cpl.core.time
|
||||
cpl.core.utils
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ Submodules
|
||||
cpl\_core.time.time\_format\_settings module
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.time.time_format_settings
|
||||
.. automodule:: cpl.core.time.time_format_settings
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -15,7 +15,7 @@ cpl\_core.time.time\_format\_settings module
|
||||
cpl\_core.time.time\_format\_settings\_names\_enum module
|
||||
---------------------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.time.time_format_settings_names_enum
|
||||
.. automodule:: cpl.core.time.time_format_settings_names_enum
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -23,7 +23,7 @@ cpl\_core.time.time\_format\_settings\_names\_enum module
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_core.time
|
||||
.. automodule:: cpl.core.time
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
@@ -7,7 +7,7 @@ Submodules
|
||||
cpl\_core.utils.credential\_manager module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: cpl_core.utils.credential_manager
|
||||
.. automodule:: cpl.core.utils.credential_manager
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -15,7 +15,7 @@ cpl\_core.utils.credential\_manager module
|
||||
cpl\_core.utils.pip module
|
||||
--------------------------
|
||||
|
||||
.. automodule:: cpl_core.utils.pip
|
||||
.. automodule:: cpl.core.utils.pip
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -23,7 +23,7 @@ cpl\_core.utils.pip module
|
||||
cpl\_core.utils.string module
|
||||
-----------------------------
|
||||
|
||||
.. automodule:: cpl_core.utils.string
|
||||
.. automodule:: cpl.core.utils.string
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -31,7 +31,7 @@ cpl\_core.utils.string module
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_core.utils
|
||||
.. automodule:: cpl.core.utils
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
12
docs/build/html/_sources/cpl_query.base.rst.txt
vendored
12
docs/build/html/_sources/cpl_query.base.rst.txt
vendored
@@ -7,7 +7,7 @@ Submodules
|
||||
cpl\_query.base.default\_lambda module
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.base.default_lambda
|
||||
.. automodule:: cpl.query.base.default_lambda
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -15,7 +15,7 @@ cpl\_query.base.default\_lambda module
|
||||
cpl\_query.base.ordered\_queryable module
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.base.ordered_queryable
|
||||
.. automodule:: cpl.query.base.ordered_queryable
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -23,7 +23,7 @@ cpl\_query.base.ordered\_queryable module
|
||||
cpl\_query.base.ordered\_queryable\_abc module
|
||||
----------------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.base.ordered_queryable_abc
|
||||
.. automodule:: cpl.query.base.ordered_queryable_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -31,7 +31,7 @@ cpl\_query.base.ordered\_queryable\_abc module
|
||||
cpl\_query.base.queryable\_abc module
|
||||
-------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.base.queryable_abc
|
||||
.. automodule:: cpl.query.base.queryable_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -39,7 +39,7 @@ cpl\_query.base.queryable\_abc module
|
||||
cpl\_query.base.sequence module
|
||||
-------------------------------
|
||||
|
||||
.. automodule:: cpl_query.base.sequence
|
||||
.. automodule:: cpl.query.base.sequence
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -47,7 +47,7 @@ cpl\_query.base.sequence module
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_query.base
|
||||
.. automodule:: cpl.query.base
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
@@ -7,7 +7,7 @@ Submodules
|
||||
cpl\_query.enumerable.enumerable module
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.enumerable.enumerable
|
||||
.. automodule:: cpl.query.enumerable.enumerable
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -15,7 +15,7 @@ cpl\_query.enumerable.enumerable module
|
||||
cpl\_query.enumerable.enumerable\_abc module
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.enumerable.enumerable_abc
|
||||
.. automodule:: cpl.query.enumerable.enumerable_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -23,7 +23,7 @@ cpl\_query.enumerable.enumerable\_abc module
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_query.enumerable
|
||||
.. automodule:: cpl.query.enumerable
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
@@ -7,7 +7,7 @@ Submodules
|
||||
cpl\_query.extension.list module
|
||||
--------------------------------
|
||||
|
||||
.. automodule:: cpl_query.extension.list
|
||||
.. automodule:: cpl.query.extension.list
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -15,7 +15,7 @@ cpl\_query.extension.list module
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_query.extension
|
||||
.. automodule:: cpl.query.extension
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
@@ -7,7 +7,7 @@ Submodules
|
||||
cpl\_query.iterable.iterable module
|
||||
-----------------------------------
|
||||
|
||||
.. automodule:: cpl_query.iterable.iterable
|
||||
.. automodule:: cpl.query.iterable.iterable
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -15,7 +15,7 @@ cpl\_query.iterable.iterable module
|
||||
cpl\_query.iterable.iterable\_abc module
|
||||
----------------------------------------
|
||||
|
||||
.. automodule:: cpl_query.iterable.iterable_abc
|
||||
.. automodule:: cpl.query.iterable.iterable_abc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -23,7 +23,7 @@ cpl\_query.iterable.iterable\_abc module
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: cpl_query.iterable
|
||||
.. automodule:: cpl.query.iterable
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
8
docs/build/html/_sources/cpl_query.rst.txt
vendored
8
docs/build/html/_sources/cpl_query.rst.txt
vendored
@@ -4,7 +4,7 @@ Query reference
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
cpl_query.base
|
||||
cpl_query.enumerable
|
||||
cpl_query.extension
|
||||
cpl_query.iterable
|
||||
cpl.query.base
|
||||
cpl.query.enumerable
|
||||
cpl.query.extension
|
||||
cpl.query.iterable
|
||||
|
||||
4
docs/build/html/_sources/index.rst.txt
vendored
4
docs/build/html/_sources/index.rst.txt
vendored
@@ -89,7 +89,7 @@ These pages go into great detail about everything the Library can do.
|
||||
contributing
|
||||
deprecated
|
||||
cpl_cli
|
||||
cpl_core
|
||||
cpl.core
|
||||
cpl_discord
|
||||
cpl_query
|
||||
cpl.query
|
||||
cpl_translation
|
||||
|
||||
4
docs/build/html/_sources/introduction.md.txt
vendored
4
docs/build/html/_sources/introduction.md.txt
vendored
@@ -55,6 +55,6 @@ This CPL docs help you learn, understand and use the package. From your first ap
|
||||
|
||||
- [Getting started](quickstart)
|
||||
- [Setup](setup)
|
||||
- [API Reference](cpl_core)
|
||||
- [API Reference](cpl.core)
|
||||
- [CLI Reference](cpl_cli.overview)
|
||||
- [Query Reference](cpl_query)
|
||||
- [Query Reference](cpl.query)
|
||||
|
||||
4
docs/build/html/_sources/modules.rst.txt
vendored
4
docs/build/html/_sources/modules.rst.txt
vendored
@@ -5,7 +5,7 @@ Packages
|
||||
:maxdepth: 4
|
||||
|
||||
cpl_cli
|
||||
cpl_core
|
||||
cpl.core
|
||||
cpl_discord
|
||||
cpl_query
|
||||
cpl.query
|
||||
cpl_translation
|
||||
|
||||
10
docs/build/html/_sources/quickstart.md.txt
vendored
10
docs/build/html/_sources/quickstart.md.txt
vendored
@@ -83,7 +83,7 @@ To create the sample project to the following:
|
||||
3. Add ```Console.select``` as follows:
|
||||
|
||||
```py
|
||||
from cpl_core.console import Console
|
||||
from cpl.core.console import Console
|
||||
|
||||
|
||||
def main():
|
||||
@@ -156,7 +156,7 @@ To create the sample project to the following:
|
||||
import random
|
||||
import string
|
||||
|
||||
from cpl_core.console import Console
|
||||
from cpl.core.console import Console
|
||||
|
||||
|
||||
def generate_password(letters: str, length: int) -> str:
|
||||
@@ -200,9 +200,9 @@ In this section, you've created an application that uses user input to generate
|
||||
|
||||
To continue exploring CPL and developing applications:
|
||||
|
||||
- [Application base](cpl_core.application)
|
||||
- [Dependency injection](cpl_core.dependency_injection)
|
||||
- [Console](cpl_core.console)
|
||||
- [Application base](cpl.core.application)
|
||||
- [Dependency injection](cpl.core.dependency_injection)
|
||||
- [Console](cpl.core.console)
|
||||
|
||||
<!-- LINKS -->
|
||||
[pip-url]: https://pip.sh-edraft.de
|
||||
|
||||
4
docs/build/html/_sources/setup.md.txt
vendored
4
docs/build/html/_sources/setup.md.txt
vendored
@@ -50,7 +50,7 @@ pip install cpl-query --extra-index-url https://pip.sh-edraft.de
|
||||
|
||||
## Create initial console app
|
||||
|
||||
You develop apps and packages in the context of an CPL project which is defined in an cpl_core.json.
|
||||
You develop apps and packages in the context of an CPL project which is defined in an cpl.core.json.
|
||||
|
||||
1. Run the CLI command ```cpl new console``` and provide the name my-app, as shown here:
|
||||
|
||||
@@ -64,7 +64,7 @@ The CLI create a new workspace and a simple 'Hello World' app, ready to run.
|
||||
|
||||
## Create initial library
|
||||
|
||||
You develop apps and packages in the context of an CPL project which is defined in an cpl_core.json.
|
||||
You develop apps and packages in the context of an CPL project which is defined in an cpl.core.json.
|
||||
|
||||
1. Run the CLI command ```cpl new library``` and provide the name my-lib, as shown here:
|
||||
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
# Use cpl_core.console.Console
|
||||
# Use cpl.core.console.Console
|
||||
|
||||
## Coming soon
|
||||
@@ -76,7 +76,7 @@ Here the template ```project_console.py``` defines how a console project has to
|
||||
```python
|
||||
from cpl_cli.abc.project_type_abc import ProjectTypeABC
|
||||
from cpl_cli.configuration import WorkspaceSettings
|
||||
from cpl_core.utils import String
|
||||
from cpl.core.utils import String
|
||||
|
||||
|
||||
class Console(ProjectTypeABC):
|
||||
@@ -142,10 +142,10 @@ class ProjectFileStartup(CodeFileTemplateABC):
|
||||
import textwrap
|
||||
|
||||
return textwrap.dedent("""\
|
||||
from cpl_core.application import StartupABC
|
||||
from cpl_core.configuration import ConfigurationABC
|
||||
from cpl_core.dependency_injection import ServiceProviderABC, ServiceCollectionABC
|
||||
from cpl_core.environment import ApplicationEnvironment
|
||||
from cpl.core.application import StartupABC
|
||||
from cpl.core.configuration import ConfigurationABC
|
||||
from cpl.core.dependency_injection import ServiceProviderABC, ServiceCollectionABC
|
||||
from cpl.core.environment import ApplicationEnvironment
|
||||
|
||||
|
||||
class Startup(StartupABC):
|
||||
|
||||
4
docs/build/html/contributing.html
vendored
4
docs/build/html/contributing.html
vendored
@@ -63,9 +63,9 @@
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
6
docs/build/html/cpl_cli.add.html
vendored
6
docs/build/html/cpl_cli.add.html
vendored
@@ -70,9 +70,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -107,7 +107,7 @@
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration.Configuration.arguments" title="cpl.core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#flags"><span class="xref myst">Flags</span></a></p></li>
|
||||
</ul>
|
||||
<p>Removes a project from workspace.</p>
|
||||
|
||||
4
docs/build/html/cpl_cli.build.html
vendored
4
docs/build/html/cpl_cli.build.html
vendored
@@ -68,9 +68,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
8
docs/build/html/cpl_cli.generate.html
vendored
8
docs/build/html/cpl_cli.generate.html
vendored
@@ -70,9 +70,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -107,7 +107,7 @@
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration.Configuration.arguments" title="cpl.core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#schematics"><span class="xref myst">Schematics</span></a></p></li>
|
||||
</ul>
|
||||
<p>Generate a file based on schematic.</p>
|
||||
@@ -176,7 +176,7 @@ cpl <strong>G</strong> <em><schematic></em> <em><name></em></p>
|
||||
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre"><name></span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">settings</span></code></p></td>
|
||||
<td class="text-center"><p><a class="reference internal" href="cpl_core.configuration.html"><span class="doc std std-doc">Configmodel</span></a></p></td>
|
||||
<td class="text-center"><p><a class="reference internal" href="cpl.core.configuration.html"><span class="doc std std-doc">Configmodel</span></a></p></td>
|
||||
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre"><name></span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">test</span></code></p></td>
|
||||
|
||||
6
docs/build/html/cpl_cli.help.html
vendored
6
docs/build/html/cpl_cli.help.html
vendored
@@ -69,9 +69,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -106,7 +106,7 @@
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration.Configuration.arguments" title="cpl.core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
</ul>
|
||||
<p>Lists available command and their short descriptions.</p>
|
||||
<p>cpl <strong>help</strong> <em><command></em> <br>
|
||||
|
||||
4
docs/build/html/cpl_cli.html
vendored
4
docs/build/html/cpl_cli.html
vendored
@@ -64,9 +64,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
6
docs/build/html/cpl_cli.install.html
vendored
6
docs/build/html/cpl_cli.install.html
vendored
@@ -70,9 +70,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -107,7 +107,7 @@
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration.Configuration.arguments" title="cpl.core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
</ul>
|
||||
<p>Installs given package via pip</p>
|
||||
<p>cpl <strong>install</strong> <em><package></em> <br>
|
||||
|
||||
6
docs/build/html/cpl_cli.new.html
vendored
6
docs/build/html/cpl_cli.new.html
vendored
@@ -70,9 +70,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -107,7 +107,7 @@
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration.Configuration.arguments" title="cpl.core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#project-types"><span class="xref myst">Project types</span></a></p></li>
|
||||
</ul>
|
||||
<p>Generates a workspace and initial project or add a project to workspace.</p>
|
||||
|
||||
4
docs/build/html/cpl_cli.overview.html
vendored
4
docs/build/html/cpl_cli.overview.html
vendored
@@ -74,9 +74,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
6
docs/build/html/cpl_cli.publish.html
vendored
6
docs/build/html/cpl_cli.publish.html
vendored
@@ -68,9 +68,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -115,7 +115,7 @@ cpl <strong>P</strong></p>
|
||||
<section id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
|
||||
<p>The command can be used to publish a project of type “console” or “library”.</p>
|
||||
<p>The publish command builds the source files and then creates an <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> with data from <code class="docutils literal notranslate"><span class="pre">cpl_core.json</span></code>.
|
||||
<p>The publish command builds the source files and then creates an <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> with data from <code class="docutils literal notranslate"><span class="pre">cpl.core.json</span></code>.
|
||||
The command executes the <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> and removes all source files with the <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> from the ‘publish/’ directory.</p>
|
||||
<p>Generated files of <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> are in the ‘publish/setup/’ directory.</p>
|
||||
<!-- ## Arguments
|
||||
|
||||
6
docs/build/html/cpl_cli.remove.html
vendored
6
docs/build/html/cpl_cli.remove.html
vendored
@@ -70,9 +70,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -107,7 +107,7 @@
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration.Configuration.arguments" title="cpl.core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
</ul>
|
||||
<p>Removes a project from workspace.</p>
|
||||
<p>cpl <strong>remove</strong> <em><project></em> <br>
|
||||
|
||||
4
docs/build/html/cpl_cli.run.html
vendored
4
docs/build/html/cpl_cli.run.html
vendored
@@ -64,9 +64,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
4
docs/build/html/cpl_cli.start.html
vendored
4
docs/build/html/cpl_cli.start.html
vendored
@@ -64,9 +64,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
6
docs/build/html/cpl_cli.uninstall.html
vendored
6
docs/build/html/cpl_cli.uninstall.html
vendored
@@ -70,9 +70,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -107,7 +107,7 @@
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration.Configuration.arguments" title="cpl.core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
</ul>
|
||||
<p>Uninstalls given package via pip</p>
|
||||
<p>cpl <strong>uninstall</strong> <em><package></em> <br>
|
||||
|
||||
4
docs/build/html/cpl_cli.update.html
vendored
4
docs/build/html/cpl_cli.update.html
vendored
@@ -67,9 +67,9 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
8
docs/build/html/cpl_cli.version.html
vendored
8
docs/build/html/cpl_cli.version.html
vendored
@@ -19,7 +19,7 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="API reference" href="cpl_core.html" />
|
||||
<link rel="next" title="API reference" href="cpl.core.html" />
|
||||
<link rel="prev" title="cpl update" href="cpl_cli.update.html" />
|
||||
</head>
|
||||
|
||||
@@ -64,9 +64,9 @@
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl version</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -108,7 +108,7 @@ cpl <strong>V</strong></p>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_cli.update.html" class="btn btn-neutral float-left" title="cpl update" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_core.html" class="btn btn-neutral float-right" title="API reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.core.html" class="btn btn-neutral float-right" title="API reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
252
docs/build/html/cpl_core.application.html
vendored
252
docs/build/html/cpl_core.application.html
vendored
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_core.application package — Common Python Library documentation</title>
|
||||
<title>cpl.core.application package — Common Python Library documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -19,8 +19,8 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="cpl_core.configuration package" href="cpl_core.configuration.html" />
|
||||
<link rel="prev" title="API reference" href="cpl_core.html" />
|
||||
<link rel="next" title="cpl.core.configuration package" href="cpl.core.configuration.html" />
|
||||
<link rel="prev" title="API reference" href="cpl.core.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -48,54 +48,54 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.application package</a><ul>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl.core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.core.application package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_abc">cpl_core.application.application_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC"><code class="docutils literal notranslate"><span class="pre">ApplicationABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.application.application_abc">cpl.core.application.application_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.application.application_abc.ApplicationABC"><code class="docutils literal notranslate"><span class="pre">ApplicationABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_builder">cpl_core.application.application_builder module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.application_builder.ApplicationBuilder"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilder</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.application.application_builder">cpl.core.application.application_builder module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.application.application_builder.ApplicationBuilder"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilder</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_builder_abc">cpl_core.application.application_builder_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilderABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.application.application_builder_abc">cpl.core.application.application_builder_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.application.application_builder_abc.ApplicationBuilderABC"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilderABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_extension_abc">cpl_core.application.application_extension_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.application_extension_abc.ApplicationExtensionABC"><code class="docutils literal notranslate"><span class="pre">ApplicationExtensionABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.application.application_extension_abc">cpl.core.application.application_extension_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.application.application_extension_abc.ApplicationExtensionABC"><code class="docutils literal notranslate"><span class="pre">ApplicationExtensionABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.startup_abc">cpl_core.application.startup_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC"><code class="docutils literal notranslate"><span class="pre">StartupABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.application.startup_abc">cpl.core.application.startup_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.application.startup_abc.StartupABC"><code class="docutils literal notranslate"><span class="pre">StartupABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.startup_extension_abc">cpl_core.application.startup_extension_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.startup_extension_abc.StartupExtensionABC"><code class="docutils literal notranslate"><span class="pre">StartupExtensionABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.application.startup_extension_abc">cpl.core.application.startup_extension_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.application.startup_extension_abc.StartupExtensionABC"><code class="docutils literal notranslate"><span class="pre">StartupExtensionABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.application">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.application.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html">cpl_core.database package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.log.html">cpl_core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_mail.html">cpl_mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.configuration.html">cpl.core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.console.html">cpl.core.console package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.database.html">cpl.core.database package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.dependency_injection.html">cpl.core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.environment.html">cpl.core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.log.html">cpl.core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mail.html">cpl.mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.pipes.html">cpl.core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.time.html">cpl.core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.utils.html">cpl.core.utils package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -113,10 +113,10 @@
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl_core.application package</li>
|
||||
<li class="breadcrumb-item"><a href="cpl.core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl.core.application package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_core.application.rst.txt" rel="nofollow"> View page source</a>
|
||||
<a href="_sources/cpl.core.application.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -125,50 +125,50 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="cpl-core-application-package">
|
||||
<h1>cpl_core.application package<a class="headerlink" href="#cpl-core-application-package" title="Permalink to this heading"></a></h1>
|
||||
<h1>cpl.core.application package<a class="headerlink" href="#cpl-core-application-package" title="Permalink to this heading"></a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_core.application.application_abc">
|
||||
<span id="cpl-core-application-application-abc-module"></span><h2>cpl_core.application.application_abc module<a class="headerlink" href="#module-cpl_core.application.application_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.application.application_abc">
|
||||
<span id="cpl-core-application-application-abc-module"></span><h2>cpl.core.application.application_abc module<a class="headerlink" href="#module-cpl.core.application.application_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_abc.ApplicationABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.application_abc.</span></span><span class="sig-name descname"><span class="pre">ApplicationABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.application_abc.ApplicationABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.application.application_abc.</span></span><span class="sig-name descname"><span class="pre">ApplicationABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_abc.ConfigurationABC" title="cpl.core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.application.application_abc.ApplicationABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<p>ABC for the Application class</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameters:</dt><dd><dl class="simple">
|
||||
<dt>config: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></code></a></dt><dd><p>Contains object loaded from appsettings</p>
|
||||
<dt>config: <a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_abc.ConfigurationABC" title="cpl.core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.configuration.configuration_abc.ConfigurationABC</span></code></a></dt><dd><p>Contains object loaded from appsettings</p>
|
||||
</dd>
|
||||
<dt>services: <a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></dt><dd><p>Contains instances of prepared objects</p>
|
||||
<dt>services: <a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></dt><dd><p>Contains instances of prepared objects</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_abc.ApplicationABC.configure">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">configure</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.configure" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.application_abc.ApplicationABC.configure">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">configure</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.application.application_abc.ApplicationABC.configure" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Configure the application</p>
|
||||
<p>Called by <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC.run" title="cpl_core.application.application_abc.ApplicationABC.run"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC.run</span></code></a></p>
|
||||
<p>Called by <a class="reference internal" href="#cpl.core.application.application_abc.ApplicationABC.run" title="cpl.core.application.application_abc.ApplicationABC.run"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.application.application_abc.ApplicationABC.run</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_abc.ApplicationABC.main">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.main" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.application_abc.ApplicationABC.main">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.application.application_abc.ApplicationABC.main" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Custom entry point</p>
|
||||
<p>Called by <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC.run" title="cpl_core.application.application_abc.ApplicationABC.run"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC.run</span></code></a></p>
|
||||
<p>Called by <a class="reference internal" href="#cpl.core.application.application_abc.ApplicationABC.run" title="cpl.core.application.application_abc.ApplicationABC.run"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.application.application_abc.ApplicationABC.run</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_abc.ApplicationABC.run">
|
||||
<span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.run" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.application_abc.ApplicationABC.run">
|
||||
<span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.application.application_abc.ApplicationABC.run" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Entry point</p>
|
||||
<p>Called by custom Application.main</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_abc.ApplicationABC.run_async">
|
||||
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">run_async</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.run_async" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.application_abc.ApplicationABC.run_async">
|
||||
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">run_async</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.application.application_abc.ApplicationABC.run_async" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Entry point</p>
|
||||
<p>Called by custom Application.main</p>
|
||||
</dd></dl>
|
||||
@@ -176,52 +176,52 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.application.application_builder">
|
||||
<span id="cpl-core-application-application-builder-module"></span><h2>cpl_core.application.application_builder module<a class="headerlink" href="#module-cpl_core.application.application_builder" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.application.application_builder">
|
||||
<span id="cpl-core-application-application-builder-module"></span><h2>cpl.core.application.application_builder module<a class="headerlink" href="#module-cpl.core.application.application_builder" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.application_builder.</span></span><span class="sig-name descname"><span class="pre">ApplicationBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">ApplicationABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC" title="cpl_core.application.application_builder_abc.ApplicationBuilderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplicationBuilderABC</span></code></a></p>
|
||||
<p>This is class is used to build an object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.application_builder.ApplicationBuilder">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.application.application_builder.</span></span><span class="sig-name descname"><span class="pre">ApplicationBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.core.application.application_abc.ApplicationABC" title="cpl.core.application.application_abc.ApplicationABC"><span class="pre">ApplicationABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.application.application_builder.ApplicationBuilder" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.application.application_builder_abc.ApplicationBuilderABC" title="cpl.core.application.application_builder_abc.ApplicationBuilderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplicationBuilderABC</span></code></a></p>
|
||||
<p>This is class is used to build an object of <a class="reference internal" href="#cpl.core.application.application_abc.ApplicationABC" title="cpl.core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.application.application_abc.ApplicationABC</span></code></a></p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>app: Type[<a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a>]</dt><dd><p>Application to build</p>
|
||||
<dt>app: Type[<a class="reference internal" href="#cpl.core.application.application_abc.ApplicationABC" title="cpl.core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.application.application_abc.ApplicationABC</span></code></a>]</dt><dd><p>Application to build</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.build">
|
||||
<span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">ApplicationABC</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.build" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.application_builder.ApplicationBuilder.build">
|
||||
<span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.application.application_abc.ApplicationABC" title="cpl.core.application.application_abc.ApplicationABC"><span class="pre">ApplicationABC</span></a></span></span><a class="headerlink" href="#cpl.core.application.application_builder.ApplicationBuilder.build" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates custom application object</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>Object of <a class="reference internal" href="#cpl.core.application.application_abc.ApplicationABC" title="cpl.core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.application.application_abc.ApplicationABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.build_async">
|
||||
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_async</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">ApplicationABC</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.build_async" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.application_builder.ApplicationBuilder.build_async">
|
||||
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_async</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.application.application_abc.ApplicationABC" title="cpl.core.application.application_abc.ApplicationABC"><span class="pre">ApplicationABC</span></a></span></span><a class="headerlink" href="#cpl.core.application.application_builder.ApplicationBuilder.build_async" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates custom application object async</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>Object of <a class="reference internal" href="#cpl.core.application.application_abc.ApplicationABC" title="cpl.core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.application.application_abc.ApplicationABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.use_extension">
|
||||
<span class="sig-name descname"><span class="pre">use_extension</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extension</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.application_extension_abc.ApplicationExtensionABC" title="cpl_core.application.application_extension_abc.ApplicationExtensionABC"><span class="pre">ApplicationExtensionABC</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.application.startup_extension_abc.StartupExtensionABC" title="cpl_core.application.startup_extension_abc.StartupExtensionABC"><span class="pre">StartupExtensionABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_builder.ApplicationBuilder" title="cpl_core.application.application_builder.ApplicationBuilder"><span class="pre">ApplicationBuilder</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_extension" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.application_builder.ApplicationBuilder.use_extension">
|
||||
<span class="sig-name descname"><span class="pre">use_extension</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extension</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.core.application.application_extension_abc.ApplicationExtensionABC" title="cpl.core.application.application_extension_abc.ApplicationExtensionABC"><span class="pre">ApplicationExtensionABC</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#cpl.core.application.startup_extension_abc.StartupExtensionABC" title="cpl.core.application.startup_extension_abc.StartupExtensionABC"><span class="pre">StartupExtensionABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.application.application_builder.ApplicationBuilder" title="cpl.core.application.application_builder.ApplicationBuilder"><span class="pre">ApplicationBuilder</span></a></span></span><a class="headerlink" href="#cpl.core.application.application_builder.ApplicationBuilder.use_extension" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.use_startup">
|
||||
<span class="sig-name descname"><span class="pre">use_startup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">startup</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><span class="pre">StartupABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_builder.ApplicationBuilder" title="cpl_core.application.application_builder.ApplicationBuilder"><span class="pre">ApplicationBuilder</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_startup" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.application_builder.ApplicationBuilder.use_startup">
|
||||
<span class="sig-name descname"><span class="pre">use_startup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">startup</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.core.application.startup_abc.StartupABC" title="cpl.core.application.startup_abc.StartupABC"><span class="pre">StartupABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.application.application_builder.ApplicationBuilder" title="cpl.core.application.application_builder.ApplicationBuilder"><span class="pre">ApplicationBuilder</span></a></span></span><a class="headerlink" href="#cpl.core.application.application_builder.ApplicationBuilder.use_startup" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets the custom startup class to use async</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>startup: Type[<a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.startup_abc.StartupABC</span></code></a>]</dt><dd><p>Startup class to use</p>
|
||||
<dt>startup: Type[<a class="reference internal" href="#cpl.core.application.startup_abc.StartupABC" title="cpl.core.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.application.startup_abc.StartupABC</span></code></a>]</dt><dd><p>Startup class to use</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
@@ -231,40 +231,40 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.application.application_builder_abc">
|
||||
<span id="cpl-core-application-application-builder-abc-module"></span><h2>cpl_core.application.application_builder_abc module<a class="headerlink" href="#module-cpl_core.application.application_builder_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.application.application_builder_abc">
|
||||
<span id="cpl-core-application-application-builder-abc-module"></span><h2>cpl.core.application.application_builder_abc module<a class="headerlink" href="#module-cpl.core.application.application_builder_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder_abc.ApplicationBuilderABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.application_builder_abc.</span></span><span class="sig-name descname"><span class="pre">ApplicationBuilderABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.application_builder_abc.ApplicationBuilderABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.application.application_builder_abc.</span></span><span class="sig-name descname"><span class="pre">ApplicationBuilderABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.application.application_builder_abc.ApplicationBuilderABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<p>ABC for the <a class="reference internal" href="#cpl_core.application.application_builder.ApplicationBuilder" title="cpl_core.application.application_builder.ApplicationBuilder"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_builder.ApplicationBuilder</span></code></a></p>
|
||||
<p>ABC for the <a class="reference internal" href="#cpl.core.application.application_builder.ApplicationBuilder" title="cpl.core.application.application_builder.ApplicationBuilder"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.application.application_builder.ApplicationBuilder</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.build">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">ApplicationABC</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC.build" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.application_builder_abc.ApplicationBuilderABC.build">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.application.application_abc.ApplicationABC" title="cpl.core.application.application_abc.ApplicationABC"><span class="pre">ApplicationABC</span></a></span></span><a class="headerlink" href="#cpl.core.application.application_builder_abc.ApplicationBuilderABC.build" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates custom application object</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>Object of <a class="reference internal" href="#cpl.core.application.application_abc.ApplicationABC" title="cpl.core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.application.application_abc.ApplicationABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.build_async">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_async</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">ApplicationABC</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC.build_async" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.application_builder_abc.ApplicationBuilderABC.build_async">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_async</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.application.application_abc.ApplicationABC" title="cpl.core.application.application_abc.ApplicationABC"><span class="pre">ApplicationABC</span></a></span></span><a class="headerlink" href="#cpl.core.application.application_builder_abc.ApplicationBuilderABC.build_async" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates custom application object async</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>Object of <a class="reference internal" href="#cpl.core.application.application_abc.ApplicationABC" title="cpl.core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.application.application_abc.ApplicationABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.use_startup">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">use_startup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">startup</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><span class="pre">StartupABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC.use_startup" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.application_builder_abc.ApplicationBuilderABC.use_startup">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">use_startup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">startup</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.core.application.startup_abc.StartupABC" title="cpl.core.application.startup_abc.StartupABC"><span class="pre">StartupABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.application.application_builder_abc.ApplicationBuilderABC.use_startup" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets the custom startup class to use async</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>startup: Type[<a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.startup_abc.StartupABC</span></code></a>]</dt><dd><p>Startup class to use</p>
|
||||
<dt>startup: Type[<a class="reference internal" href="#cpl.core.application.startup_abc.StartupABC" title="cpl.core.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.application.startup_abc.StartupABC</span></code></a>]</dt><dd><p>Startup class to use</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
@@ -274,49 +274,49 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.application.application_extension_abc">
|
||||
<span id="cpl-core-application-application-extension-abc-module"></span><h2>cpl_core.application.application_extension_abc module<a class="headerlink" href="#module-cpl_core.application.application_extension_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.application.application_extension_abc">
|
||||
<span id="cpl-core-application-application-extension-abc-module"></span><h2>cpl.core.application.application_extension_abc module<a class="headerlink" href="#module-cpl.core.application.application_extension_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_extension_abc.ApplicationExtensionABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.application_extension_abc.</span></span><span class="sig-name descname"><span class="pre">ApplicationExtensionABC</span></span><a class="headerlink" href="#cpl_core.application.application_extension_abc.ApplicationExtensionABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.application_extension_abc.ApplicationExtensionABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.application.application_extension_abc.</span></span><span class="sig-name descname"><span class="pre">ApplicationExtensionABC</span></span><a class="headerlink" href="#cpl.core.application.application_extension_abc.ApplicationExtensionABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_extension_abc.ApplicationExtensionABC.run">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_extension_abc.ApplicationExtensionABC.run" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.application_extension_abc.ApplicationExtensionABC.run">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_abc.ConfigurationABC" title="cpl.core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.application.application_extension_abc.ApplicationExtensionABC.run" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.application.startup_abc">
|
||||
<span id="cpl-core-application-startup-abc-module"></span><h2>cpl_core.application.startup_abc module<a class="headerlink" href="#module-cpl_core.application.startup_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.application.startup_abc">
|
||||
<span id="cpl-core-application-startup-abc-module"></span><h2>cpl.core.application.startup_abc module<a class="headerlink" href="#module-cpl.core.application.startup_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.startup_abc.StartupABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.startup_abc.</span></span><span class="sig-name descname"><span class="pre">StartupABC</span></span><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.startup_abc.StartupABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.application.startup_abc.</span></span><span class="sig-name descname"><span class="pre">StartupABC</span></span><a class="headerlink" href="#cpl.core.application.startup_abc.StartupABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<p>ABC for the startup class</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.startup_abc.StartupABC.configure_configuration">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">configure_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></span><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC.configure_configuration" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.startup_abc.StartupABC.configure_configuration">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">configure_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_abc.ConfigurationABC" title="cpl.core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.environment.html#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_abc.ConfigurationABC" title="cpl.core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></span><a class="headerlink" href="#cpl.core.application.startup_abc.StartupABC.configure_configuration" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates configuration of application</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><p>config: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></code></a>
|
||||
env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_core.environment.application_environment_abc" title="cpl_core.environment.application_environment_abc"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.environment.application_environment_abc</span></code></a></p>
|
||||
<dt>Parameter:</dt><dd><p>config: <a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_abc.ConfigurationABC" title="cpl.core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.configuration.configuration_abc.ConfigurationABC</span></code></a>
|
||||
env: <a class="reference internal" href="cpl.core.environment.html#module-cpl.core.environment.application_environment_abc" title="cpl.core.environment.application_environment_abc"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.environment.application_environment_abc</span></code></a></p>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>Object of <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>Object of <a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_abc.ConfigurationABC" title="cpl.core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.configuration.configuration_abc.ConfigurationABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.startup_abc.StartupABC.configure_services">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">configure_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></span><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC.configure_services" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.startup_abc.StartupABC.configure_services">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">configure_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.environment.html#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></span><a class="headerlink" href="#cpl.core.application.startup_abc.StartupABC.configure_services" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates service provider</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><p>services: <a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_collection_abc" title="cpl_core.dependency_injection.service_collection_abc"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection_abc</span></code></a>
|
||||
env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_core.environment.application_environment_abc" title="cpl_core.environment.application_environment_abc"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.environment.application_environment_abc</span></code></a></p>
|
||||
<dt>Parameter:</dt><dd><p>services: <a class="reference internal" href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.service_collection_abc" title="cpl.core.dependency_injection.service_collection_abc"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_collection_abc</span></code></a>
|
||||
env: <a class="reference internal" href="cpl.core.environment.html#module-cpl.core.environment.application_environment_abc" title="cpl.core.environment.application_environment_abc"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.environment.application_environment_abc</span></code></a></p>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>Object of <a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>Object of <a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -324,31 +324,31 @@ env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_co
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.application.startup_extension_abc">
|
||||
<span id="cpl-core-application-startup-extension-abc-module"></span><h2>cpl_core.application.startup_extension_abc module<a class="headerlink" href="#module-cpl_core.application.startup_extension_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.application.startup_extension_abc">
|
||||
<span id="cpl-core-application-startup-extension-abc-module"></span><h2>cpl.core.application.startup_extension_abc module<a class="headerlink" href="#module-cpl.core.application.startup_extension_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.startup_extension_abc.StartupExtensionABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.startup_extension_abc.</span></span><span class="sig-name descname"><span class="pre">StartupExtensionABC</span></span><a class="headerlink" href="#cpl_core.application.startup_extension_abc.StartupExtensionABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.startup_extension_abc.StartupExtensionABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.application.startup_extension_abc.</span></span><span class="sig-name descname"><span class="pre">StartupExtensionABC</span></span><a class="headerlink" href="#cpl.core.application.startup_extension_abc.StartupExtensionABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<p>ABC for startup extension classes</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.startup_extension_abc.StartupExtensionABC.configure_configuration">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">configure_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.startup_extension_abc.StartupExtensionABC.configure_configuration" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.startup_extension_abc.StartupExtensionABC.configure_configuration">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">configure_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_abc.ConfigurationABC" title="cpl.core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.environment.html#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.application.startup_extension_abc.StartupExtensionABC.configure_configuration" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates configuration of application</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><p>config: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></code></a>
|
||||
env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_core.environment.application_environment_abc" title="cpl_core.environment.application_environment_abc"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.environment.application_environment_abc</span></code></a></p>
|
||||
<dt>Parameter:</dt><dd><p>config: <a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_abc.ConfigurationABC" title="cpl.core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.configuration.configuration_abc.ConfigurationABC</span></code></a>
|
||||
env: <a class="reference internal" href="cpl.core.environment.html#module-cpl.core.environment.application_environment_abc" title="cpl.core.environment.application_environment_abc"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.environment.application_environment_abc</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.startup_extension_abc.StartupExtensionABC.configure_services">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">configure_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.startup_extension_abc.StartupExtensionABC.configure_services" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.startup_extension_abc.StartupExtensionABC.configure_services">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">configure_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.environment.html#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.application.startup_extension_abc.StartupExtensionABC.configure_services" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates service provider</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><p>services: <a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_collection_abc" title="cpl_core.dependency_injection.service_collection_abc"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection_abc</span></code></a>
|
||||
env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_core.environment.application_environment_abc" title="cpl_core.environment.application_environment_abc"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.environment.application_environment_abc</span></code></a></p>
|
||||
<dt>Parameter:</dt><dd><p>services: <a class="reference internal" href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.service_collection_abc" title="cpl.core.dependency_injection.service_collection_abc"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_collection_abc</span></code></a>
|
||||
env: <a class="reference internal" href="cpl.core.environment.html#module-cpl.core.environment.application_environment_abc" title="cpl.core.environment.application_environment_abc"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.environment.application_environment_abc</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -356,8 +356,8 @@ env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_co
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.application">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_core.application" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.application">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl.core.application" title="Permalink to this heading"></a></h2>
|
||||
<section id="cpl-core-cpl-core">
|
||||
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL core package</p>
|
||||
@@ -373,24 +373,24 @@ env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_co
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.application.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.application.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_core.application.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl.core.application.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_core.application.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl.core.application.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_core.application.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.application.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl.core.application.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
@@ -403,8 +403,8 @@ env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_co
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_core.html" class="btn btn-neutral float-left" title="API reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_core.configuration.html" class="btn btn-neutral float-right" title="cpl_core.configuration package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.core.html" class="btn btn-neutral float-left" title="API reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl.core.configuration.html" class="btn btn-neutral float-right" title="cpl.core.configuration package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
440
docs/build/html/cpl_core.configuration.html
vendored
440
docs/build/html/cpl_core.configuration.html
vendored
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_core.configuration package — Common Python Library documentation</title>
|
||||
<title>cpl.core.configuration package — Common Python Library documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -19,8 +19,8 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="cpl_core.console package" href="cpl_core.console.html" />
|
||||
<link rel="prev" title="cpl_core.application package" href="cpl_core.application.html" />
|
||||
<link rel="next" title="cpl.core.console package" href="cpl.core.console.html" />
|
||||
<link rel="prev" title="cpl.core.application package" href="cpl.core.application.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -48,79 +48,79 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.configuration package</a><ul>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl.core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.application.html">cpl.core.application package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.core.configuration package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_abc">cpl_core.configuration.argument_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.argument_abc.ArgumentABC"><code class="docutils literal notranslate"><span class="pre">ArgumentABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.configuration.argument_abc">cpl.core.configuration.argument_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.configuration.argument_abc.ArgumentABC"><code class="docutils literal notranslate"><span class="pre">ArgumentABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_builder">cpl_core.configuration.argument_builder module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.argument_builder.ArgumentBuilder"><code class="docutils literal notranslate"><span class="pre">ArgumentBuilder</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.configuration.argument_builder">cpl.core.configuration.argument_builder module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.configuration.argument_builder.ArgumentBuilder"><code class="docutils literal notranslate"><span class="pre">ArgumentBuilder</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_executable_abc">cpl_core.configuration.argument_executable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC"><code class="docutils literal notranslate"><span class="pre">ArgumentExecutableABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.configuration.argument_executable_abc">cpl.core.configuration.argument_executable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.configuration.argument_executable_abc.ArgumentExecutableABC"><code class="docutils literal notranslate"><span class="pre">ArgumentExecutableABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_type_enum">cpl_core.configuration.argument_type_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum"><code class="docutils literal notranslate"><span class="pre">ArgumentTypeEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.configuration.argument_type_enum">cpl.core.configuration.argument_type_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.configuration.argument_type_enum.ArgumentTypeEnum"><code class="docutils literal notranslate"><span class="pre">ArgumentTypeEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration">cpl_core.configuration.configuration module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.configuration.Configuration"><code class="docutils literal notranslate"><span class="pre">Configuration</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.configuration.configuration">cpl.core.configuration.configuration module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.configuration.configuration.Configuration"><code class="docutils literal notranslate"><span class="pre">Configuration</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration_abc">cpl_core.configuration.configuration_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="docutils literal notranslate"><span class="pre">ConfigurationABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.configuration.configuration_abc">cpl.core.configuration.configuration_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.configuration.configuration_abc.ConfigurationABC"><code class="docutils literal notranslate"><span class="pre">ConfigurationABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration_model_abc">cpl_core.configuration.configuration_model_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.base_func"><code class="docutils literal notranslate"><span class="pre">base_func()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.configuration.configuration_model_abc">cpl.core.configuration.configuration_model_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.configuration.configuration_model_abc.base_func"><code class="docutils literal notranslate"><span class="pre">base_func()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration_variable_name_enum">cpl_core.configuration.configuration_variable_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum"><code class="docutils literal notranslate"><span class="pre">ConfigurationVariableNameEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.configuration.configuration_variable_name_enum">cpl.core.configuration.configuration_variable_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum"><code class="docutils literal notranslate"><span class="pre">ConfigurationVariableNameEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.executable_argument">cpl_core.configuration.executable_argument module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.executable_argument.ExecutableArgument"><code class="docutils literal notranslate"><span class="pre">ExecutableArgument</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.configuration.executable_argument">cpl.core.configuration.executable_argument module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.configuration.executable_argument.ExecutableArgument"><code class="docutils literal notranslate"><span class="pre">ExecutableArgument</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.flag_argument">cpl_core.configuration.flag_argument module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.flag_argument.FlagArgument"><code class="docutils literal notranslate"><span class="pre">FlagArgument</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.configuration.flag_argument">cpl.core.configuration.flag_argument module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.configuration.flag_argument.FlagArgument"><code class="docutils literal notranslate"><span class="pre">FlagArgument</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.validator_abc">cpl_core.configuration.validator_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.validator_abc.ValidatorABC"><code class="docutils literal notranslate"><span class="pre">ValidatorABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.configuration.validator_abc">cpl.core.configuration.validator_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.configuration.validator_abc.ValidatorABC"><code class="docutils literal notranslate"><span class="pre">ValidatorABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.variable_argument">cpl_core.configuration.variable_argument module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.variable_argument.VariableArgument"><code class="docutils literal notranslate"><span class="pre">VariableArgument</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.configuration.variable_argument">cpl.core.configuration.variable_argument module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.configuration.variable_argument.VariableArgument"><code class="docutils literal notranslate"><span class="pre">VariableArgument</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.configuration">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.configuration.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html">cpl_core.database package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.log.html">cpl_core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_mail.html">cpl_mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.console.html">cpl.core.console package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.database.html">cpl.core.database package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.dependency_injection.html">cpl.core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.environment.html">cpl.core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.log.html">cpl.core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mail.html">cpl.mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.pipes.html">cpl.core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.time.html">cpl.core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.utils.html">cpl.core.utils package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -138,10 +138,10 @@
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl_core.configuration package</li>
|
||||
<li class="breadcrumb-item"><a href="cpl.core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl.core.configuration package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_core.configuration.rst.txt" rel="nofollow"> View page source</a>
|
||||
<a href="_sources/cpl.core.configuration.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -150,19 +150,19 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="cpl-core-configuration-package">
|
||||
<h1>cpl_core.configuration package<a class="headerlink" href="#cpl-core-configuration-package" title="Permalink to this heading"></a></h1>
|
||||
<h1>cpl.core.configuration package<a class="headerlink" href="#cpl-core-configuration-package" title="Permalink to this heading"></a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_core.configuration.argument_abc">
|
||||
<span id="cpl-core-configuration-argument-abc-module"></span><h2>cpl_core.configuration.argument_abc module<a class="headerlink" href="#module-cpl_core.configuration.argument_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.configuration.argument_abc">
|
||||
<span id="cpl-core-configuration-argument-abc-module"></span><h2>cpl.core.configuration.argument_abc module<a class="headerlink" href="#module-cpl.core.configuration.argument_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.argument_abc.ArgumentABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.argument_abc.</span></span><span class="sig-name descname"><span class="pre">ArgumentABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.argument_abc.ArgumentABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.configuration.argument_abc.</span></span><span class="sig-name descname"><span class="pre">ArgumentABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.argument_abc.ArgumentABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.argument_abc.ArgumentABC.add_console_argument">
|
||||
<span class="sig-name descname"><span class="pre">add_console_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum" title="cpl_core.configuration.argument_type_enum.ArgumentTypeEnum"><span class="pre">ArgumentTypeEnum</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="cpl_core.configuration.argument_abc.ArgumentABC"><span class="pre">ArgumentABC</span></a></span></span><a class="headerlink" href="#cpl_core.configuration.argument_abc.ArgumentABC.add_console_argument" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.argument_abc.ArgumentABC.add_console_argument">
|
||||
<span class="sig-name descname"><span class="pre">add_console_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.configuration.argument_type_enum.ArgumentTypeEnum" title="cpl.core.configuration.argument_type_enum.ArgumentTypeEnum"><span class="pre">ArgumentTypeEnum</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.configuration.argument_abc.ArgumentABC" title="cpl.core.configuration.argument_abc.ArgumentABC"><span class="pre">ArgumentABC</span></a></span></span><a class="headerlink" href="#cpl.core.configuration.argument_abc.ArgumentABC.add_console_argument" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates and adds a console argument to known console arguments</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -170,101 +170,101 @@
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>self <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.console_argument.ConsoleArgument</span></code> not created argument!</p>
|
||||
<dt>Returns:</dt><dd><p>self <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.configuration.console_argument.ConsoleArgument</span></code> not created argument!</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.argument_abc.ArgumentABC.aliases">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.argument_abc.ArgumentABC.aliases" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.argument_abc.ArgumentABC.aliases">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl.core.configuration.argument_abc.ArgumentABC.aliases" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.argument_abc.ArgumentABC.console_arguments">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">console_arguments</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.argument_abc.ArgumentABC.console_arguments" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.argument_abc.ArgumentABC.console_arguments">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">console_arguments</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl.core.configuration.argument_abc.ArgumentABC.console_arguments" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.argument_abc.ArgumentABC.name">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.configuration.argument_abc.ArgumentABC.name" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.argument_abc.ArgumentABC.name">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.configuration.argument_abc.ArgumentABC.name" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.argument_abc.ArgumentABC.prevent_next_executable">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">prevent_next_executable</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#cpl_core.configuration.argument_abc.ArgumentABC.prevent_next_executable" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.argument_abc.ArgumentABC.prevent_next_executable">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">prevent_next_executable</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#cpl.core.configuration.argument_abc.ArgumentABC.prevent_next_executable" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.argument_abc.ArgumentABC.token">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">token</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.configuration.argument_abc.ArgumentABC.token" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.argument_abc.ArgumentABC.token">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">token</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.configuration.argument_abc.ArgumentABC.token" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.configuration.argument_builder">
|
||||
<span id="cpl-core-configuration-argument-builder-module"></span><h2>cpl_core.configuration.argument_builder module<a class="headerlink" href="#module-cpl_core.configuration.argument_builder" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.configuration.argument_builder">
|
||||
<span id="cpl-core-configuration-argument-builder-module"></span><h2>cpl.core.configuration.argument_builder module<a class="headerlink" href="#module-cpl.core.configuration.argument_builder" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.argument_builder.ArgumentBuilder">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.argument_builder.</span></span><span class="sig-name descname"><span class="pre">ArgumentBuilder</span></span><a class="headerlink" href="#cpl_core.configuration.argument_builder.ArgumentBuilder" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.argument_builder.ArgumentBuilder">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.configuration.argument_builder.</span></span><span class="sig-name descname"><span class="pre">ArgumentBuilder</span></span><a class="headerlink" href="#cpl.core.configuration.argument_builder.ArgumentBuilder" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.argument_builder.ArgumentBuilder.build_argument">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum" title="cpl_core.configuration.argument_type_enum.ArgumentTypeEnum"><span class="pre">ArgumentTypeEnum</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.configuration.executable_argument.ExecutableArgument" title="cpl_core.configuration.executable_argument.ExecutableArgument"><span class="pre">ExecutableArgument</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.configuration.flag_argument.FlagArgument" title="cpl_core.configuration.flag_argument.FlagArgument"><span class="pre">FlagArgument</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.configuration.variable_argument.VariableArgument" title="cpl_core.configuration.variable_argument.VariableArgument"><span class="pre">VariableArgument</span></a></span></span><a class="headerlink" href="#cpl_core.configuration.argument_builder.ArgumentBuilder.build_argument" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.argument_builder.ArgumentBuilder.build_argument">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.configuration.argument_type_enum.ArgumentTypeEnum" title="cpl.core.configuration.argument_type_enum.ArgumentTypeEnum"><span class="pre">ArgumentTypeEnum</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.configuration.executable_argument.ExecutableArgument" title="cpl.core.configuration.executable_argument.ExecutableArgument"><span class="pre">ExecutableArgument</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#cpl.core.configuration.flag_argument.FlagArgument" title="cpl.core.configuration.flag_argument.FlagArgument"><span class="pre">FlagArgument</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#cpl.core.configuration.variable_argument.VariableArgument" title="cpl.core.configuration.variable_argument.VariableArgument"><span class="pre">VariableArgument</span></a></span></span><a class="headerlink" href="#cpl.core.configuration.argument_builder.ArgumentBuilder.build_argument" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.configuration.argument_executable_abc">
|
||||
<span id="cpl-core-configuration-argument-executable-abc-module"></span><h2>cpl_core.configuration.argument_executable_abc module<a class="headerlink" href="#module-cpl_core.configuration.argument_executable_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.configuration.argument_executable_abc">
|
||||
<span id="cpl-core-configuration-argument-executable-abc-module"></span><h2>cpl.core.configuration.argument_executable_abc module<a class="headerlink" href="#module-cpl.core.configuration.argument_executable_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.argument_executable_abc.</span></span><span class="sig-name descname"><span class="pre">ArgumentExecutableABC</span></span><a class="headerlink" href="#cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.argument_executable_abc.ArgumentExecutableABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.configuration.argument_executable_abc.</span></span><span class="sig-name descname"><span class="pre">ArgumentExecutableABC</span></span><a class="headerlink" href="#cpl.core.configuration.argument_executable_abc.ArgumentExecutableABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC.run">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC.run" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.argument_executable_abc.ArgumentExecutableABC.run">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.argument_executable_abc.ArgumentExecutableABC.run" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.configuration.argument_type_enum">
|
||||
<span id="cpl-core-configuration-argument-type-enum-module"></span><h2>cpl_core.configuration.argument_type_enum module<a class="headerlink" href="#module-cpl_core.configuration.argument_type_enum" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.configuration.argument_type_enum">
|
||||
<span id="cpl-core-configuration-argument-type-enum-module"></span><h2>cpl.core.configuration.argument_type_enum module<a class="headerlink" href="#module-cpl.core.configuration.argument_type_enum" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.argument_type_enum.ArgumentTypeEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.argument_type_enum.</span></span><span class="sig-name descname"><span class="pre">ArgumentTypeEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.argument_type_enum.ArgumentTypeEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.configuration.argument_type_enum.</span></span><span class="sig-name descname"><span class="pre">ArgumentTypeEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.argument_type_enum.ArgumentTypeEnum" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
||||
<p>An enumeration.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.argument_type_enum.ArgumentTypeEnum.Executable">
|
||||
<span class="sig-name descname"><span class="pre">Executable</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum.Executable" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.argument_type_enum.ArgumentTypeEnum.Executable">
|
||||
<span class="sig-name descname"><span class="pre">Executable</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#cpl.core.configuration.argument_type_enum.ArgumentTypeEnum.Executable" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.argument_type_enum.ArgumentTypeEnum.Flag">
|
||||
<span class="sig-name descname"><span class="pre">Flag</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum.Flag" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.argument_type_enum.ArgumentTypeEnum.Flag">
|
||||
<span class="sig-name descname"><span class="pre">Flag</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#cpl.core.configuration.argument_type_enum.ArgumentTypeEnum.Flag" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.argument_type_enum.ArgumentTypeEnum.Variable">
|
||||
<span class="sig-name descname"><span class="pre">Variable</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum.Variable" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.argument_type_enum.ArgumentTypeEnum.Variable">
|
||||
<span class="sig-name descname"><span class="pre">Variable</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#cpl.core.configuration.argument_type_enum.ArgumentTypeEnum.Variable" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.configuration.configuration">
|
||||
<span id="cpl-core-configuration-configuration-module"></span><h2>cpl_core.configuration.configuration module<a class="headerlink" href="#module-cpl_core.configuration.configuration" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.configuration.configuration">
|
||||
<span id="cpl-core-configuration-configuration-module"></span><h2>cpl.core.configuration.configuration module<a class="headerlink" href="#module-cpl.core.configuration.configuration" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration.</span></span><span class="sig-name descname"><span class="pre">Configuration</span></span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration.Configuration">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.configuration.configuration.</span></span><span class="sig-name descname"><span class="pre">Configuration</span></span><a class="headerlink" href="#cpl.core.configuration.configuration.Configuration" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.configuration.configuration_abc.ConfigurationABC" title="cpl.core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.add_configuration">
|
||||
<span class="sig-name descname"><span class="pre">add_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">any</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_configuration" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration.Configuration.add_configuration">
|
||||
<span class="sig-name descname"><span class="pre">add_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">any</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.configuration.Configuration.add_configuration" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Add configuration object</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -278,12 +278,12 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.add_console_argument">
|
||||
<span class="sig-name descname"><span class="pre">add_console_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argument</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="cpl_core.configuration.argument_abc.ArgumentABC"><span class="pre">ArgumentABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_console_argument" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration.Configuration.add_console_argument">
|
||||
<span class="sig-name descname"><span class="pre">add_console_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argument</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.configuration.argument_abc.ArgumentABC" title="cpl.core.configuration.argument_abc.ArgumentABC"><span class="pre">ArgumentABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.configuration.Configuration.add_console_argument" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds console argument to known console arguments</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>argument: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.console_argument.ConsoleArgumentABC</span></code></dt><dd><p>Specifies the console argument</p>
|
||||
<dt>argument: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.configuration.console_argument.ConsoleArgumentABC</span></code></dt><dd><p>Specifies the console argument</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
@@ -291,8 +291,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.add_environment_variables">
|
||||
<span class="sig-name descname"><span class="pre">add_environment_variables</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_environment_variables" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration.Configuration.add_environment_variables">
|
||||
<span class="sig-name descname"><span class="pre">add_environment_variables</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.configuration.Configuration.add_environment_variables" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Reads the environment variables</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -304,8 +304,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.add_json_file">
|
||||
<span class="sig-name descname"><span class="pre">add_json_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_json_file" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration.Configuration.add_json_file">
|
||||
<span class="sig-name descname"><span class="pre">add_json_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.configuration.Configuration.add_json_file" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Reads and saves settings from given json file</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -323,23 +323,23 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.additional_arguments">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">additional_arguments</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.additional_arguments" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration.Configuration.additional_arguments">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">additional_arguments</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl.core.configuration.configuration.Configuration.additional_arguments" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.argument_error_function">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">argument_error_function</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.argument_error_function" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration.Configuration.argument_error_function">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">argument_error_function</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl.core.configuration.configuration.Configuration.argument_error_function" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.arguments">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">arguments</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="cpl_core.configuration.argument_abc.ArgumentABC"><span class="pre">cpl_core.configuration.argument_abc.ArgumentABC</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.arguments" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration.Configuration.arguments">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">arguments</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.core.configuration.argument_abc.ArgumentABC" title="cpl.core.configuration.argument_abc.ArgumentABC"><span class="pre">cpl.core.configuration.argument_abc.ArgumentABC</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl.core.configuration.configuration.Configuration.arguments" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.create_console_argument">
|
||||
<span class="sig-name descname"><span class="pre">create_console_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum" title="cpl_core.configuration.argument_type_enum.ArgumentTypeEnum"><span class="pre">ArgumentTypeEnum</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="cpl_core.configuration.argument_abc.ArgumentABC"><span class="pre">ArgumentABC</span></a></span></span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.create_console_argument" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration.Configuration.create_console_argument">
|
||||
<span class="sig-name descname"><span class="pre">create_console_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.configuration.argument_type_enum.ArgumentTypeEnum" title="cpl.core.configuration.argument_type_enum.ArgumentTypeEnum"><span class="pre">ArgumentTypeEnum</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.configuration.argument_abc.ArgumentABC" title="cpl.core.configuration.argument_abc.ArgumentABC"><span class="pre">ArgumentABC</span></a></span></span><a class="headerlink" href="#cpl.core.configuration.configuration.Configuration.create_console_argument" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates and adds a console argument to known console arguments</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -353,23 +353,23 @@
|
||||
</dd>
|
||||
<dt>is_value_token_optional <code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></dt><dd><p>Specifies if values are optional</p>
|
||||
</dd>
|
||||
<dt>runnable: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.console_argument.ConsoleArgumentABC</span></code></dt><dd><p>Specifies class to run when called if value is not None</p>
|
||||
<dt>runnable: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.configuration.console_argument.ConsoleArgumentABC</span></code></dt><dd><p>Specifies class to run when called if value is not None</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>Object of <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.console_argument.ConsoleArgumentABC</span></code></p>
|
||||
<dt>Returns:</dt><dd><p>Object of <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.configuration.console_argument.ConsoleArgumentABC</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.environment">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">environment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></em><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.environment" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration.Configuration.environment">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">environment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="cpl.core.environment.html#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></em><a class="headerlink" href="#cpl.core.configuration.configuration.Configuration.environment" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.for_each_argument">
|
||||
<span class="sig-name descname"><span class="pre">for_each_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">call</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.for_each_argument" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration.Configuration.for_each_argument">
|
||||
<span class="sig-name descname"><span class="pre">for_each_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">call</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.configuration.Configuration.for_each_argument" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Iterates through all arguments and calls the call function</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -381,23 +381,23 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.get_configuration">
|
||||
<span class="sig-name descname"><span class="pre">get_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.get_configuration" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration.Configuration.get_configuration">
|
||||
<span class="sig-name descname"><span class="pre">get_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl.core.configuration.configuration.Configuration.get_configuration" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns value from configuration by given type</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>search_type: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, Type[<a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a>]]</dt><dd><p>Type to search for</p>
|
||||
<dt>search_type: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, Type[<a class="reference internal" href="#cpl.core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a>]]</dt><dd><p>Type to search for</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>Object of Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a>]</p>
|
||||
<dt>Returns:</dt><dd><p>Object of Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl.core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.parse_console_arguments">
|
||||
<span class="sig-name descname"><span class="pre">parse_console_arguments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.parse_console_arguments" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration.Configuration.parse_console_arguments">
|
||||
<span class="sig-name descname"><span class="pre">parse_console_arguments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl.core.configuration.configuration.Configuration.parse_console_arguments" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Reads the console arguments</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -413,15 +413,15 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.configuration.configuration_abc">
|
||||
<span id="cpl-core-configuration-configuration-abc-module"></span><h2>cpl_core.configuration.configuration_abc module<a class="headerlink" href="#module-cpl_core.configuration.configuration_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.configuration.configuration_abc">
|
||||
<span id="cpl-core-configuration-configuration-abc-module"></span><h2>cpl.core.configuration.configuration_abc module<a class="headerlink" href="#module-cpl.core.configuration.configuration_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_abc.</span></span><span class="sig-name descname"><span class="pre">ConfigurationABC</span></span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_abc.ConfigurationABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.configuration.configuration_abc.</span></span><span class="sig-name descname"><span class="pre">ConfigurationABC</span></span><a class="headerlink" href="#cpl.core.configuration.configuration_abc.ConfigurationABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_configuration">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">any</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_configuration" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_abc.ConfigurationABC.add_configuration">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">any</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.configuration_abc.ConfigurationABC.add_configuration" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Add configuration object</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -435,12 +435,12 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_argument">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_console_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argument</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="cpl_core.configuration.argument_abc.ArgumentABC"><span class="pre">ArgumentABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_argument" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_abc.ConfigurationABC.add_console_argument">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_console_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argument</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.configuration.argument_abc.ArgumentABC" title="cpl.core.configuration.argument_abc.ArgumentABC"><span class="pre">ArgumentABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.configuration_abc.ConfigurationABC.add_console_argument" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds console argument to known console arguments</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>argument: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.console_argument.ConsoleArgumentABC</span></code></dt><dd><p>Specifies the console argument</p>
|
||||
<dt>argument: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.configuration.console_argument.ConsoleArgumentABC</span></code></dt><dd><p>Specifies the console argument</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
@@ -448,8 +448,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_environment_variables">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_environment_variables</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_environment_variables" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_abc.ConfigurationABC.add_environment_variables">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_environment_variables</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.configuration_abc.ConfigurationABC.add_environment_variables" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Reads the environment variables</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -461,8 +461,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_json_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_abc.ConfigurationABC.add_json_file">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_json_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.configuration_abc.ConfigurationABC.add_json_file" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Reads and saves settings from given json file</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -480,23 +480,23 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.additional_arguments">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">additional_arguments</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.additional_arguments" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_abc.ConfigurationABC.additional_arguments">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">additional_arguments</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl.core.configuration.configuration_abc.ConfigurationABC.additional_arguments" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">argument_error_function</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_abc.ConfigurationABC.argument_error_function">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">argument_error_function</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl.core.configuration.configuration_abc.ConfigurationABC.argument_error_function" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.arguments">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">arguments</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="cpl_core.configuration.argument_abc.ArgumentABC"><span class="pre">cpl_core.configuration.argument_abc.ArgumentABC</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.arguments" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_abc.ConfigurationABC.arguments">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">arguments</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.core.configuration.argument_abc.ArgumentABC" title="cpl.core.configuration.argument_abc.ArgumentABC"><span class="pre">cpl.core.configuration.argument_abc.ArgumentABC</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl.core.configuration.configuration_abc.ConfigurationABC.arguments" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.create_console_argument">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_console_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum" title="cpl_core.configuration.argument_type_enum.ArgumentTypeEnum"><span class="pre">ArgumentTypeEnum</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="cpl_core.configuration.argument_abc.ArgumentABC"><span class="pre">ArgumentABC</span></a></span></span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.create_console_argument" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_abc.ConfigurationABC.create_console_argument">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_console_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.configuration.argument_type_enum.ArgumentTypeEnum" title="cpl.core.configuration.argument_type_enum.ArgumentTypeEnum"><span class="pre">ArgumentTypeEnum</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.configuration.argument_abc.ArgumentABC" title="cpl.core.configuration.argument_abc.ArgumentABC"><span class="pre">ArgumentABC</span></a></span></span><a class="headerlink" href="#cpl.core.configuration.configuration_abc.ConfigurationABC.create_console_argument" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates and adds a console argument to known console arguments</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -510,23 +510,23 @@
|
||||
</dd>
|
||||
<dt>is_value_token_optional <code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></dt><dd><p>Specifies if values are optional</p>
|
||||
</dd>
|
||||
<dt>runnable: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.console_argument.ConsoleArgumentABC</span></code></dt><dd><p>Specifies class to run when called if value is not None</p>
|
||||
<dt>runnable: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.configuration.console_argument.ConsoleArgumentABC</span></code></dt><dd><p>Specifies class to run when called if value is not None</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>Object of <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.console_argument.ConsoleArgumentABC</span></code></p>
|
||||
<dt>Returns:</dt><dd><p>Object of <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.configuration.console_argument.ConsoleArgumentABC</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.environment">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">environment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></em><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.environment" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_abc.ConfigurationABC.environment">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">environment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="cpl.core.environment.html#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></em><a class="headerlink" href="#cpl.core.configuration.configuration_abc.ConfigurationABC.environment" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.for_each_argument">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">for_each_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">call</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.for_each_argument" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_abc.ConfigurationABC.for_each_argument">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">for_each_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">call</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.configuration_abc.ConfigurationABC.for_each_argument" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Iterates through all arguments and calls the call function</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -538,23 +538,23 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_abc.ConfigurationABC.get_configuration">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl.core.configuration.configuration_abc.ConfigurationABC.get_configuration" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns value from configuration by given type</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>search_type: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, Type[<a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a>]]</dt><dd><p>Type to search for</p>
|
||||
<dt>search_type: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, Type[<a class="reference internal" href="#cpl.core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a>]]</dt><dd><p>Type to search for</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>Object of Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a>]</p>
|
||||
<dt>Returns:</dt><dd><p>Object of Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl.core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.parse_console_arguments">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_console_arguments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.parse_console_arguments" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_abc.ConfigurationABC.parse_console_arguments">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_console_arguments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl.core.configuration.configuration_abc.ConfigurationABC.parse_console_arguments" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Reads the console arguments</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -570,15 +570,15 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.configuration.configuration_model_abc">
|
||||
<span id="cpl-core-configuration-configuration-model-abc-module"></span><h2>cpl_core.configuration.configuration_model_abc module<a class="headerlink" href="#module-cpl_core.configuration.configuration_model_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.configuration.configuration_model_abc">
|
||||
<span id="cpl-core-configuration-configuration-model-abc-module"></span><h2>cpl.core.configuration.configuration_model_abc module<a class="headerlink" href="#module-cpl.core.configuration.configuration_model_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_model_abc.</span></span><span class="sig-name descname"><span class="pre">ConfigurationModelABC</span></span><a class="headerlink" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_model_abc.ConfigurationModelABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.configuration.configuration_model_abc.</span></span><span class="sig-name descname"><span class="pre">ConfigurationModelABC</span></span><a class="headerlink" href="#cpl.core.configuration.configuration_model_abc.ConfigurationModelABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict">
|
||||
<span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict">
|
||||
<span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>DEPRECATED: Set attributes as typed arguments in __init__ instead. See <a class="reference external" href="https://docs.sh-edraft.de/cpl/deprecated.html#ConfigurationModelABC-from_dict-method">https://docs.sh-edraft.de/cpl/deprecated.html#ConfigurationModelABC-from_dict-method</a> for further information
|
||||
Converts attributes to dict</p>
|
||||
<dl class="simple">
|
||||
@@ -590,120 +590,120 @@ Converts attributes to dict</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_model_abc.base_func">
|
||||
<span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_model_abc.</span></span><span class="sig-name descname"><span class="pre">base_func</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_model_abc.base_func" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_model_abc.base_func">
|
||||
<span class="sig-prename descclassname"><span class="pre">cpl.core.configuration.configuration_model_abc.</span></span><span class="sig-name descname"><span class="pre">base_func</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.configuration_model_abc.base_func" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.configuration.configuration_variable_name_enum">
|
||||
<span id="cpl-core-configuration-configuration-variable-name-enum-module"></span><h2>cpl_core.configuration.configuration_variable_name_enum module<a class="headerlink" href="#module-cpl_core.configuration.configuration_variable_name_enum" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.configuration.configuration_variable_name_enum">
|
||||
<span id="cpl-core-configuration-configuration-variable-name-enum-module"></span><h2>cpl.core.configuration.configuration_variable_name_enum module<a class="headerlink" href="#module-cpl.core.configuration.configuration_variable_name_enum" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_variable_name_enum.</span></span><span class="sig-name descname"><span class="pre">ConfigurationVariableNameEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.configuration.configuration_variable_name_enum.</span></span><span class="sig-name descname"><span class="pre">ConfigurationVariableNameEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
||||
<p>An enumeration.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.customer">
|
||||
<span class="sig-name descname"><span class="pre">customer</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CUSTOMER'</span></em><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.customer" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.customer">
|
||||
<span class="sig-name descname"><span class="pre">customer</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CUSTOMER'</span></em><a class="headerlink" href="#cpl.core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.customer" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.environment">
|
||||
<span class="sig-name descname"><span class="pre">environment</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ENVIRONMENT'</span></em><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.environment" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.environment">
|
||||
<span class="sig-name descname"><span class="pre">environment</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ENVIRONMENT'</span></em><a class="headerlink" href="#cpl.core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.environment" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.name">
|
||||
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NAME'</span></em><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.name" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.name">
|
||||
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NAME'</span></em><a class="headerlink" href="#cpl.core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.name" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.to_list">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">to_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.to_list" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.to_list">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">to_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.to_list" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.configuration.executable_argument">
|
||||
<span id="cpl-core-configuration-executable-argument-module"></span><h2>cpl_core.configuration.executable_argument module<a class="headerlink" href="#module-cpl_core.configuration.executable_argument" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.configuration.executable_argument">
|
||||
<span id="cpl-core-configuration-executable-argument-module"></span><h2>cpl.core.configuration.executable_argument module<a class="headerlink" href="#module-cpl.core.configuration.executable_argument" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.executable_argument.ExecutableArgument">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.executable_argument.</span></span><span class="sig-name descname"><span class="pre">ExecutableArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC" title="cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC"><span class="pre">ArgumentExecutableABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validators</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.validator_abc.ValidatorABC" title="cpl_core.configuration.validator_abc.ValidatorABC"><span class="pre">cpl_core.configuration.validator_abc.ValidatorABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.executable_argument.ExecutableArgument" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="cpl_core.configuration.argument_abc.ArgumentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.executable_argument.ExecutableArgument">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.configuration.executable_argument.</span></span><span class="sig-name descname"><span class="pre">ExecutableArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.core.configuration.argument_executable_abc.ArgumentExecutableABC" title="cpl.core.configuration.argument_executable_abc.ArgumentExecutableABC"><span class="pre">ArgumentExecutableABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validators</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.core.configuration.validator_abc.ValidatorABC" title="cpl.core.configuration.validator_abc.ValidatorABC"><span class="pre">cpl.core.configuration.validator_abc.ValidatorABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.executable_argument.ExecutableArgument" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.configuration.argument_abc.ArgumentABC" title="cpl.core.configuration.argument_abc.ArgumentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentABC</span></code></a></p>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.executable_argument.ExecutableArgument.executable_type">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">executable_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span></em><a class="headerlink" href="#cpl_core.configuration.executable_argument.ExecutableArgument.executable_type" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.executable_argument.ExecutableArgument.executable_type">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">executable_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span></em><a class="headerlink" href="#cpl.core.configuration.executable_argument.ExecutableArgument.executable_type" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.executable_argument.ExecutableArgument.run">
|
||||
<span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.executable_argument.ExecutableArgument.run" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.executable_argument.ExecutableArgument.run">
|
||||
<span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.executable_argument.ExecutableArgument.run" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Executes runnable if exists</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.executable_argument.ExecutableArgument.set_executable">
|
||||
<span class="sig-name descname"><span class="pre">set_executable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC" title="cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC"><span class="pre">ArgumentExecutableABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.executable_argument.ExecutableArgument.set_executable" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.executable_argument.ExecutableArgument.set_executable">
|
||||
<span class="sig-name descname"><span class="pre">set_executable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.configuration.argument_executable_abc.ArgumentExecutableABC" title="cpl.core.configuration.argument_executable_abc.ArgumentExecutableABC"><span class="pre">ArgumentExecutableABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.executable_argument.ExecutableArgument.set_executable" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.executable_argument.ExecutableArgument.validators">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validators</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.validator_abc.ValidatorABC" title="cpl_core.configuration.validator_abc.ValidatorABC"><span class="pre">cpl_core.configuration.validator_abc.ValidatorABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.executable_argument.ExecutableArgument.validators" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.executable_argument.ExecutableArgument.validators">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validators</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.core.configuration.validator_abc.ValidatorABC" title="cpl.core.configuration.validator_abc.ValidatorABC"><span class="pre">cpl.core.configuration.validator_abc.ValidatorABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl.core.configuration.executable_argument.ExecutableArgument.validators" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.configuration.flag_argument">
|
||||
<span id="cpl-core-configuration-flag-argument-module"></span><h2>cpl_core.configuration.flag_argument module<a class="headerlink" href="#module-cpl_core.configuration.flag_argument" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.configuration.flag_argument">
|
||||
<span id="cpl-core-configuration-flag-argument-module"></span><h2>cpl.core.configuration.flag_argument module<a class="headerlink" href="#module-cpl.core.configuration.flag_argument" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.flag_argument.FlagArgument">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.flag_argument.</span></span><span class="sig-name descname"><span class="pre">FlagArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.flag_argument.FlagArgument" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="cpl_core.configuration.argument_abc.ArgumentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.flag_argument.FlagArgument">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.configuration.flag_argument.</span></span><span class="sig-name descname"><span class="pre">FlagArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.flag_argument.FlagArgument" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.configuration.argument_abc.ArgumentABC" title="cpl.core.configuration.argument_abc.ArgumentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentABC</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.configuration.validator_abc">
|
||||
<span id="cpl-core-configuration-validator-abc-module"></span><h2>cpl_core.configuration.validator_abc module<a class="headerlink" href="#module-cpl_core.configuration.validator_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.configuration.validator_abc">
|
||||
<span id="cpl-core-configuration-validator-abc-module"></span><h2>cpl.core.configuration.validator_abc module<a class="headerlink" href="#module-cpl.core.configuration.validator_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.validator_abc.ValidatorABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.validator_abc.</span></span><span class="sig-name descname"><span class="pre">ValidatorABC</span></span><a class="headerlink" href="#cpl_core.configuration.validator_abc.ValidatorABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.validator_abc.ValidatorABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.configuration.validator_abc.</span></span><span class="sig-name descname"><span class="pre">ValidatorABC</span></span><a class="headerlink" href="#cpl.core.configuration.validator_abc.ValidatorABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.validator_abc.ValidatorABC.validate">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_core.configuration.validator_abc.ValidatorABC.validate" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.validator_abc.ValidatorABC.validate">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl.core.configuration.validator_abc.ValidatorABC.validate" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.configuration.variable_argument">
|
||||
<span id="cpl-core-configuration-variable-argument-module"></span><h2>cpl_core.configuration.variable_argument module<a class="headerlink" href="#module-cpl_core.configuration.variable_argument" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.configuration.variable_argument">
|
||||
<span id="cpl-core-configuration-variable-argument-module"></span><h2>cpl.core.configuration.variable_argument module<a class="headerlink" href="#module-cpl.core.configuration.variable_argument" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.variable_argument.VariableArgument">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.variable_argument.</span></span><span class="sig-name descname"><span class="pre">VariableArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value_token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.variable_argument.VariableArgument" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="cpl_core.configuration.argument_abc.ArgumentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.variable_argument.VariableArgument">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.configuration.variable_argument.</span></span><span class="sig-name descname"><span class="pre">VariableArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value_token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.variable_argument.VariableArgument" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.configuration.argument_abc.ArgumentABC" title="cpl.core.configuration.argument_abc.ArgumentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.variable_argument.VariableArgument.set_value">
|
||||
<span class="sig-name descname"><span class="pre">set_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.variable_argument.VariableArgument.set_value" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.variable_argument.VariableArgument.set_value">
|
||||
<span class="sig-name descname"><span class="pre">set_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.variable_argument.VariableArgument.set_value" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.variable_argument.VariableArgument.value">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.configuration.variable_argument.VariableArgument.value" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.variable_argument.VariableArgument.value">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.configuration.variable_argument.VariableArgument.value" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.variable_argument.VariableArgument.value_token">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value_token</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.configuration.variable_argument.VariableArgument.value_token" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.variable_argument.VariableArgument.value_token">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">value_token</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.configuration.variable_argument.VariableArgument.value_token" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.configuration">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_core.configuration" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.configuration">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl.core.configuration" title="Permalink to this heading"></a></h2>
|
||||
<section id="cpl-core-cpl-core">
|
||||
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL core package</p>
|
||||
@@ -719,24 +719,24 @@ Converts attributes to dict</p>
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.configuration.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.configuration.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_core.configuration.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl.core.configuration.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_core.configuration.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl.core.configuration.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_core.configuration.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.configuration.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl.core.configuration.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
@@ -749,8 +749,8 @@ Converts attributes to dict</p>
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_core.application.html" class="btn btn-neutral float-left" title="cpl_core.application package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_core.console.html" class="btn btn-neutral float-right" title="cpl_core.console package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.core.application.html" class="btn btn-neutral float-left" title="cpl.core.application package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl.core.console.html" class="btn btn-neutral float-right" title="cpl.core.console package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
340
docs/build/html/cpl_core.console.html
vendored
340
docs/build/html/cpl_core.console.html
vendored
File diff suppressed because one or more lines are too long
126
docs/build/html/cpl_core.database.connection.html
vendored
126
docs/build/html/cpl_core.database.connection.html
vendored
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_core.database.connection package — Common Python Library documentation</title>
|
||||
<title>cpl.core.database.connection package — Common Python Library documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -19,8 +19,8 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="cpl_core.database.context package" href="cpl_core.database.context.html" />
|
||||
<link rel="prev" title="cpl_core.database package" href="cpl_core.database.html" />
|
||||
<link rel="next" title="cpl.core.database.context package" href="cpl.core.database.context.html" />
|
||||
<link rel="prev" title="cpl.core.database package" href="cpl.core.database.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -48,34 +48,34 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console package</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="cpl_core.database.html">cpl_core.database package</a><ul class="current">
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="cpl_core.database.html#subpackages">Subpackages</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="current reference internal" href="#">cpl_core.database.connection package</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context package</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl.core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.application.html">cpl.core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.configuration.html">cpl.core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.console.html">cpl.core.console package</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="cpl.core.database.html">cpl.core.database package</a><ul class="current">
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="cpl.core.database.html#subpackages">Subpackages</a><ul class="current">
|
||||
<li class="toctree-l4 current"><a class="current reference internal" href="#">cpl.core.database.connection package</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.context.html">cpl.core.database.context package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings">cpl_core.database.database_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.table_abc">cpl_core.database.table_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database">Module contents</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.html#module-cpl.core.database.database_settings">cpl.core.database.database_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.html#module-cpl.core.database.database_settings_name_enum">cpl.core.database.database_settings_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.html#module-cpl.core.database.table_abc">cpl.core.database.table_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.html#module-cpl.core.database">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.log.html">cpl_core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_mail.html">cpl_mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.dependency_injection.html">cpl.core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.environment.html">cpl.core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.log.html">cpl.core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mail.html">cpl.mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.pipes.html">cpl.core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.time.html">cpl.core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.utils.html">cpl.core.utils package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -93,11 +93,11 @@
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.database.html">cpl_core.database package</a></li>
|
||||
<li class="breadcrumb-item active">cpl_core.database.connection package</li>
|
||||
<li class="breadcrumb-item"><a href="cpl.core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl.core.database.html">cpl.core.database package</a></li>
|
||||
<li class="breadcrumb-item active">cpl.core.database.connection package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_core.database.connection.rst.txt" rel="nofollow"> View page source</a>
|
||||
<a href="_sources/cpl.core.database.connection.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -106,20 +106,20 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="cpl-core-database-connection-package">
|
||||
<h1>cpl_core.database.connection package<a class="headerlink" href="#cpl-core-database-connection-package" title="Permalink to this heading"></a></h1>
|
||||
<h1>cpl.core.database.connection package<a class="headerlink" href="#cpl-core-database-connection-package" title="Permalink to this heading"></a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_core.database.connection.database_connection">
|
||||
<span id="cpl-core-database-connection-database-connection-module"></span><h2>cpl_core.database.connection.database_connection module<a class="headerlink" href="#module-cpl_core.database.connection.database_connection" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.database.connection.database_connection">
|
||||
<span id="cpl-core-database-connection-database-connection-module"></span><h2>cpl.core.database.connection.database_connection module<a class="headerlink" href="#module-cpl.core.database.connection.database_connection" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection.DatabaseConnection">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.connection.database_connection.</span></span><span class="sig-name descname"><span class="pre">DatabaseConnection</span></span><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC" title="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatabaseConnectionABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.connection.database_connection.DatabaseConnection">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.database.connection.database_connection.</span></span><span class="sig-name descname"><span class="pre">DatabaseConnection</span></span><a class="headerlink" href="#cpl.core.database.connection.database_connection.DatabaseConnection" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.database.connection.database_connection_abc.DatabaseConnectionABC" title="cpl.core.database.connection.database_connection_abc.DatabaseConnectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatabaseConnectionABC</span></code></a></p>
|
||||
<p>Representation of the database connection</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection.DatabaseConnection.connect">
|
||||
<span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection.connect" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.connection.database_connection.DatabaseConnection.connect">
|
||||
<span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.database.html#cpl.core.database.database_settings.DatabaseSettings" title="cpl.core.database.database_settings.DatabaseSettings"><span class="pre">DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.database.connection.database_connection.DatabaseConnection.connect" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Connects to a database by connection string</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -131,28 +131,28 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection.DatabaseConnection.cursor">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cursor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">MySQLCursorBuffered</span></em><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection.cursor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.connection.database_connection.DatabaseConnection.cursor">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cursor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">MySQLCursorBuffered</span></em><a class="headerlink" href="#cpl.core.database.connection.database_connection.DatabaseConnection.cursor" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection.DatabaseConnection.server">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">server</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">MySQLConnectionAbstract</span></em><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection.server" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.connection.database_connection.DatabaseConnection.server">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">server</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">MySQLConnectionAbstract</span></em><a class="headerlink" href="#cpl.core.database.connection.database_connection.DatabaseConnection.server" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.database.connection.database_connection_abc">
|
||||
<span id="cpl-core-database-connection-database-connection-abc-module"></span><h2>cpl_core.database.connection.database_connection_abc module<a class="headerlink" href="#module-cpl_core.database.connection.database_connection_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.database.connection.database_connection_abc">
|
||||
<span id="cpl-core-database-connection-database-connection-abc-module"></span><h2>cpl.core.database.connection.database_connection_abc module<a class="headerlink" href="#module-cpl.core.database.connection.database_connection_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.connection.database_connection_abc.</span></span><span class="sig-name descname"><span class="pre">DatabaseConnectionABC</span></span><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.connection.database_connection_abc.DatabaseConnectionABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.database.connection.database_connection_abc.</span></span><span class="sig-name descname"><span class="pre">DatabaseConnectionABC</span></span><a class="headerlink" href="#cpl.core.database.connection.database_connection_abc.DatabaseConnectionABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<p>ABC for the <a class="reference internal" href="#cpl_core.database.connection.database_connection.DatabaseConnection" title="cpl_core.database.connection.database_connection.DatabaseConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.connection.database_connection.DatabaseConnection</span></code></a></p>
|
||||
<p>ABC for the <a class="reference internal" href="#cpl.core.database.connection.database_connection.DatabaseConnection" title="cpl.core.database.connection.database_connection.DatabaseConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.database.connection.database_connection.DatabaseConnection</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.connect">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.connect" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.connection.database_connection_abc.DatabaseConnectionABC.connect">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.database.html#cpl.core.database.database_settings.DatabaseSettings" title="cpl.core.database.database_settings.DatabaseSettings"><span class="pre">DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.database.connection.database_connection_abc.DatabaseConnectionABC.connect" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Connects to a database by connection string</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -164,20 +164,20 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.cursor">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cursor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">MySQLCursorBuffered</span></em><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.cursor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.connection.database_connection_abc.DatabaseConnectionABC.cursor">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cursor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">MySQLCursorBuffered</span></em><a class="headerlink" href="#cpl.core.database.connection.database_connection_abc.DatabaseConnectionABC.cursor" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.server">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">server</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">MySQLConnectionAbstract</span></em><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.server" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.connection.database_connection_abc.DatabaseConnectionABC.server">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">server</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">MySQLConnectionAbstract</span></em><a class="headerlink" href="#cpl.core.database.connection.database_connection_abc.DatabaseConnectionABC.server" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.database.connection">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_core.database.connection" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.database.connection">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl.core.database.connection" title="Permalink to this heading"></a></h2>
|
||||
<section id="cpl-core-cpl-core">
|
||||
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL core package</p>
|
||||
@@ -193,24 +193,24 @@
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.connection.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.connection.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.connection.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.database.connection.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.database.connection.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_core.database.connection.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.connection.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl.core.database.connection.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_core.database.connection.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.connection.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl.core.database.connection.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_core.database.connection.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.connection.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl.core.database.connection.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
@@ -223,8 +223,8 @@
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_core.database.html" class="btn btn-neutral float-left" title="cpl_core.database package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_core.database.context.html" class="btn btn-neutral float-right" title="cpl_core.database.context package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.core.database.html" class="btn btn-neutral float-left" title="cpl.core.database package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl.core.database.context.html" class="btn btn-neutral float-right" title="cpl.core.database.context package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
140
docs/build/html/cpl_core.database.context.html
vendored
140
docs/build/html/cpl_core.database.context.html
vendored
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_core.database.context package — Common Python Library documentation</title>
|
||||
<title>cpl.core.database.context package — Common Python Library documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -19,8 +19,8 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="cpl_core.dependency_injection package" href="cpl_core.dependency_injection.html" />
|
||||
<link rel="prev" title="cpl_core.database.connection package" href="cpl_core.database.connection.html" />
|
||||
<link rel="next" title="cpl.core.dependency_injection package" href="cpl.core.dependency_injection.html" />
|
||||
<link rel="prev" title="cpl.core.database.connection package" href="cpl.core.database.connection.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -48,34 +48,34 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console package</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="cpl_core.database.html">cpl_core.database package</a><ul class="current">
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="cpl_core.database.html#subpackages">Subpackages</a><ul class="current">
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html">cpl_core.database.connection package</a></li>
|
||||
<li class="toctree-l4 current"><a class="current reference internal" href="#">cpl_core.database.context package</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl.core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.application.html">cpl.core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.configuration.html">cpl.core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.console.html">cpl.core.console package</a></li>
|
||||
<li class="toctree-l2 current"><a class="reference internal" href="cpl.core.database.html">cpl.core.database package</a><ul class="current">
|
||||
<li class="toctree-l3 current"><a class="reference internal" href="cpl.core.database.html#subpackages">Subpackages</a><ul class="current">
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.connection.html">cpl.core.database.connection package</a></li>
|
||||
<li class="toctree-l4 current"><a class="current reference internal" href="#">cpl.core.database.context package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings">cpl_core.database.database_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.table_abc">cpl_core.database.table_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database">Module contents</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.html#module-cpl.core.database.database_settings">cpl.core.database.database_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.html#module-cpl.core.database.database_settings_name_enum">cpl.core.database.database_settings_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.html#module-cpl.core.database.table_abc">cpl.core.database.table_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.html#module-cpl.core.database">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.log.html">cpl_core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_mail.html">cpl_mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.dependency_injection.html">cpl.core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.environment.html">cpl.core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.log.html">cpl.core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mail.html">cpl.mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.pipes.html">cpl.core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.time.html">cpl.core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.utils.html">cpl.core.utils package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -93,11 +93,11 @@
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.database.html">cpl_core.database package</a></li>
|
||||
<li class="breadcrumb-item active">cpl_core.database.context package</li>
|
||||
<li class="breadcrumb-item"><a href="cpl.core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl.core.database.html">cpl.core.database package</a></li>
|
||||
<li class="breadcrumb-item active">cpl.core.database.context package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_core.database.context.rst.txt" rel="nofollow"> View page source</a>
|
||||
<a href="_sources/cpl.core.database.context.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -106,45 +106,45 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="cpl-core-database-context-package">
|
||||
<h1>cpl_core.database.context package<a class="headerlink" href="#cpl-core-database-context-package" title="Permalink to this heading"></a></h1>
|
||||
<h1>cpl.core.database.context package<a class="headerlink" href="#cpl-core-database-context-package" title="Permalink to this heading"></a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_core.database.context.database_context">
|
||||
<span id="cpl-core-database-context-database-context-module"></span><h2>cpl_core.database.context.database_context module<a class="headerlink" href="#module-cpl_core.database.context.database_context" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.database.context.database_context">
|
||||
<span id="cpl-core-database-context-database-context-module"></span><h2>cpl.core.database.context.database_context module<a class="headerlink" href="#module-cpl.core.database.context.database_context" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.context.database_context.</span></span><span class="sig-name descname"><span class="pre">DatabaseContext</span></span><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatabaseContextABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.context.database_context.DatabaseContext">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.database.context.database_context.</span></span><span class="sig-name descname"><span class="pre">DatabaseContext</span></span><a class="headerlink" href="#cpl.core.database.context.database_context.DatabaseContext" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.database.context.database_context_abc.DatabaseContextABC" title="cpl.core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatabaseContextABC</span></code></a></p>
|
||||
<p>Representation of the database context</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><p>database_settings: <a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></code></a></p>
|
||||
<dt>Parameter:</dt><dd><p>database_settings: <a class="reference internal" href="cpl.core.database.html#cpl.core.database.database_settings.DatabaseSettings" title="cpl.core.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.database.database_settings.DatabaseSettings</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext.connect">
|
||||
<span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.connect" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.context.database_context.DatabaseContext.connect">
|
||||
<span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.database.html#cpl.core.database.database_settings.DatabaseSettings" title="cpl.core.database.database_settings.DatabaseSettings"><span class="pre">DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.database.context.database_context.DatabaseContext.connect" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Connects to a database by connection settings</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><p>database_settings <a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></code></a></p>
|
||||
<dt>Parameter:</dt><dd><p>database_settings <a class="reference internal" href="cpl.core.database.html#cpl.core.database.database_settings.DatabaseSettings" title="cpl.core.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.database.database_settings.DatabaseSettings</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext.cursor">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cursor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">MySQLCursorBuffered</span></em><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.cursor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.context.database_context.DatabaseContext.cursor">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cursor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">MySQLCursorBuffered</span></em><a class="headerlink" href="#cpl.core.database.context.database_context.DatabaseContext.cursor" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext.save_changes">
|
||||
<span class="sig-name descname"><span class="pre">save_changes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.save_changes" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.context.database_context.DatabaseContext.save_changes">
|
||||
<span class="sig-name descname"><span class="pre">save_changes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.database.context.database_context.DatabaseContext.save_changes" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Saves changes of the database</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext.select">
|
||||
<span class="sig-name descname"><span class="pre">select</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">statement</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.select" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.context.database_context.DatabaseContext.select">
|
||||
<span class="sig-name descname"><span class="pre">select</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">statement</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl.core.database.context.database_context.DatabaseContext.select" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Runs SQL Statements</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><p>statement: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
@@ -157,37 +157,37 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.database.context.database_context_abc">
|
||||
<span id="cpl-core-database-context-database-context-abc-module"></span><h2>cpl_core.database.context.database_context_abc module<a class="headerlink" href="#module-cpl_core.database.context.database_context_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.database.context.database_context_abc">
|
||||
<span id="cpl-core-database-context-database-context-abc-module"></span><h2>cpl.core.database.context.database_context_abc module<a class="headerlink" href="#module-cpl.core.database.context.database_context_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.context.database_context_abc.</span></span><span class="sig-name descname"><span class="pre">DatabaseContextABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.context.database_context_abc.DatabaseContextABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.database.context.database_context_abc.</span></span><span class="sig-name descname"><span class="pre">DatabaseContextABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.database.context.database_context_abc.DatabaseContextABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<p>ABC for the <a class="reference internal" href="#cpl_core.database.context.database_context.DatabaseContext" title="cpl_core.database.context.database_context.DatabaseContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.context.database_context.DatabaseContext</span></code></a></p>
|
||||
<p>ABC for the <a class="reference internal" href="#cpl.core.database.context.database_context.DatabaseContext" title="cpl.core.database.context.database_context.DatabaseContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.database.context.database_context.DatabaseContext</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC.connect">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.connect" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.context.database_context_abc.DatabaseContextABC.connect">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.database.html#cpl.core.database.database_settings.DatabaseSettings" title="cpl.core.database.database_settings.DatabaseSettings"><span class="pre">DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.database.context.database_context_abc.DatabaseContextABC.connect" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Connects to a database by connection settings</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><p>database_settings <a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></code></a></p>
|
||||
<dt>Parameter:</dt><dd><p>database_settings <a class="reference internal" href="cpl.core.database.html#cpl.core.database.database_settings.DatabaseSettings" title="cpl.core.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.database.database_settings.DatabaseSettings</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC.cursor">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cursor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">MySQLCursorBuffered</span></em><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.cursor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.context.database_context_abc.DatabaseContextABC.cursor">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cursor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">MySQLCursorBuffered</span></em><a class="headerlink" href="#cpl.core.database.context.database_context_abc.DatabaseContextABC.cursor" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC.save_changes">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">save_changes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.save_changes" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.context.database_context_abc.DatabaseContextABC.save_changes">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">save_changes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.database.context.database_context_abc.DatabaseContextABC.save_changes" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Saves changes of the database</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC.select">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">select</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">statement</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.select" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.context.database_context_abc.DatabaseContextABC.select">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">select</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">statement</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl.core.database.context.database_context_abc.DatabaseContextABC.select" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Runs SQL Statements</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><p>statement: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
@@ -200,8 +200,8 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.database.context">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_core.database.context" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.database.context">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl.core.database.context" title="Permalink to this heading"></a></h2>
|
||||
<section id="cpl-core-cpl-core">
|
||||
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL core package</p>
|
||||
@@ -217,24 +217,24 @@
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.context.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.context.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.database.context.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.database.context.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_core.database.context.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.context.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl.core.database.context.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_core.database.context.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.context.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl.core.database.context.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_core.database.context.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.context.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl.core.database.context.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
@@ -247,8 +247,8 @@
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_core.database.connection.html" class="btn btn-neutral float-left" title="cpl_core.database.connection package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_core.dependency_injection.html" class="btn btn-neutral float-right" title="cpl_core.dependency_injection package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.core.database.connection.html" class="btn btn-neutral float-left" title="cpl.core.database.connection package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl.core.dependency_injection.html" class="btn btn-neutral float-right" title="cpl.core.dependency_injection package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
278
docs/build/html/cpl_core.database.html
vendored
278
docs/build/html/cpl_core.database.html
vendored
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_core.database package — Common Python Library documentation</title>
|
||||
<title>cpl.core.database package — Common Python Library documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -19,8 +19,8 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="cpl_core.database.connection package" href="cpl_core.database.connection.html" />
|
||||
<link rel="prev" title="cpl_core.console package" href="cpl_core.console.html" />
|
||||
<link rel="next" title="cpl.core.database.connection package" href="cpl.core.database.connection.html" />
|
||||
<link rel="prev" title="cpl.core.console package" href="cpl.core.console.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -48,47 +48,47 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.database package</a><ul>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl.core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.application.html">cpl.core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.configuration.html">cpl.core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.console.html">cpl.core.console package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.core.database package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html">cpl_core.database.connection package</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context package</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.connection.html">cpl.core.database.connection package</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.context.html">cpl.core.database.context package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings">cpl_core.database.database_settings module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.database.database_settings.DatabaseSettings"><code class="docutils literal notranslate"><span class="pre">DatabaseSettings</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.database.database_settings">cpl.core.database.database_settings module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.database.database_settings.DatabaseSettings"><code class="docutils literal notranslate"><span class="pre">DatabaseSettings</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">DatabaseSettingsNameEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.database.database_settings_name_enum">cpl.core.database.database_settings_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">DatabaseSettingsNameEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.table_abc">cpl_core.database.table_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.database.table_abc.TableABC"><code class="docutils literal notranslate"><span class="pre">TableABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.database.table_abc">cpl.core.database.table_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.database.table_abc.TableABC"><code class="docutils literal notranslate"><span class="pre">TableABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.database">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.database.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.database.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.log.html">cpl_core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_mail.html">cpl_mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.dependency_injection.html">cpl.core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.environment.html">cpl.core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.log.html">cpl.core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mail.html">cpl.mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.pipes.html">cpl.core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.time.html">cpl.core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.utils.html">cpl.core.utils package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -106,10 +106,10 @@
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl_core.database package</li>
|
||||
<li class="breadcrumb-item"><a href="cpl.core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl.core.database package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_core.database.rst.txt" rel="nofollow"> View page source</a>
|
||||
<a href="_sources/cpl.core.database.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -118,71 +118,71 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="cpl-core-database-package">
|
||||
<h1>cpl_core.database package<a class="headerlink" href="#cpl-core-database-package" title="Permalink to this heading"></a></h1>
|
||||
<h1>cpl.core.database package<a class="headerlink" href="#cpl-core-database-package" title="Permalink to this heading"></a></h1>
|
||||
<section id="subpackages">
|
||||
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this heading"></a></h2>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.database.connection.html">cpl_core.database.connection package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#module-cpl_core.database.connection.database_connection">cpl_core.database.connection.database_connection module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection.DatabaseConnection"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection.DatabaseConnection.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection.connect()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection.DatabaseConnection.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection.cursor</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection.DatabaseConnection.server"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection.server</span></code></a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.database.connection.html">cpl.core.database.connection package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.database.connection.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.database.connection.html#module-cpl.core.database.connection.database_connection">cpl.core.database.connection.database_connection module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.connection.html#cpl.core.database.connection.database_connection.DatabaseConnection"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.connection.html#cpl.core.database.connection.database_connection.DatabaseConnection.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection.connect()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.connection.html#cpl.core.database.connection.database_connection.DatabaseConnection.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection.cursor</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.connection.html#cpl.core.database.connection.database_connection.DatabaseConnection.server"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection.server</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#module-cpl_core.database.connection.database_connection_abc">cpl_core.database.connection.database_connection_abc module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC.connect()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC.cursor</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.server"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC.server</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.database.connection.html#module-cpl.core.database.connection.database_connection_abc">cpl.core.database.connection.database_connection_abc module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.connection.html#cpl.core.database.connection.database_connection_abc.DatabaseConnectionABC"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.connection.html#cpl.core.database.connection.database_connection_abc.DatabaseConnectionABC.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC.connect()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.connection.html#cpl.core.database.connection.database_connection_abc.DatabaseConnectionABC.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC.cursor</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.connection.html#cpl.core.database.connection.database_connection_abc.DatabaseConnectionABC.server"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC.server</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#module-cpl_core.database.connection">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.database.connection.html#module-cpl.core.database.connection">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.connection.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.connection.html#cpl.core.database.connection.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.connection.html#cpl.core.database.connection.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.connection.html#cpl.core.database.connection.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.connection.html#cpl.core.database.connection.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#module-cpl_core.database.context.database_context">cpl_core.database.context.database_context module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext"><code class="docutils literal notranslate"><span class="pre">DatabaseContext</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.connect()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.cursor</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext.save_changes"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.save_changes()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext.select"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.select()</span></code></a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.database.context.html">cpl.core.database.context package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.database.context.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.database.context.html#module-cpl.core.database.context.database_context">cpl.core.database.context.database_context module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context.DatabaseContext"><code class="docutils literal notranslate"><span class="pre">DatabaseContext</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context.DatabaseContext.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.connect()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context.DatabaseContext.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.cursor</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context.DatabaseContext.save_changes"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.save_changes()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context.DatabaseContext.select"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.select()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#module-cpl_core.database.context.database_context_abc">cpl_core.database.context.database_context_abc module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.connect()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.cursor</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC.save_changes"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.save_changes()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC.select"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.select()</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.database.context.html#module-cpl.core.database.context.database_context_abc">cpl.core.database.context.database_context_abc module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context_abc.DatabaseContextABC"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context_abc.DatabaseContextABC.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.connect()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context_abc.DatabaseContextABC.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.cursor</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context_abc.DatabaseContextABC.save_changes"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.save_changes()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context_abc.DatabaseContextABC.select"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.select()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#module-cpl_core.database.context">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.database.context.html#module-cpl.core.database.context">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.context.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -195,152 +195,152 @@
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_core.database.database_settings">
|
||||
<span id="cpl-core-database-database-settings-module"></span><h2>cpl_core.database.database_settings module<a class="headerlink" href="#module-cpl_core.database.database_settings" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.database.database_settings">
|
||||
<span id="cpl-core-database-database-settings-module"></span><h2>cpl.core.database.database_settings module<a class="headerlink" href="#module-cpl.core.database.database_settings" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.database_settings.</span></span><span class="sig-name descname"><span class="pre">DatabaseSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">databse</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">charset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_unicode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffered</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth_plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings.DatabaseSettings">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.database.database_settings.</span></span><span class="sig-name descname"><span class="pre">DatabaseSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">databse</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">charset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_unicode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffered</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth_plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.database.database_settings.DatabaseSettings" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
|
||||
<p>Represents settings for the database connection</p>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.auth_plugin">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">auth_plugin</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.auth_plugin" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings.DatabaseSettings.auth_plugin">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">auth_plugin</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl.core.database.database_settings.DatabaseSettings.auth_plugin" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.buffered">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">buffered</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.buffered" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings.DatabaseSettings.buffered">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">buffered</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl.core.database.database_settings.DatabaseSettings.buffered" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.charset">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">charset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.charset" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings.DatabaseSettings.charset">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">charset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl.core.database.database_settings.DatabaseSettings.charset" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.database">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">database</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.database" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings.DatabaseSettings.database">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">database</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl.core.database.database_settings.DatabaseSettings.database" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.host">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.host" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings.DatabaseSettings.host">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl.core.database.database_settings.DatabaseSettings.host" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.password">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">password</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.password" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings.DatabaseSettings.password">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">password</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl.core.database.database_settings.DatabaseSettings.password" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.port">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.port" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings.DatabaseSettings.port">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl.core.database.database_settings.DatabaseSettings.port" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.use_unicode">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">use_unicode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.use_unicode" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings.DatabaseSettings.use_unicode">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">use_unicode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl.core.database.database_settings.DatabaseSettings.use_unicode" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.user">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.user" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings.DatabaseSettings.user">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl.core.database.database_settings.DatabaseSettings.user" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.database.database_settings_name_enum">
|
||||
<span id="cpl-core-database-database-settings-name-enum-module"></span><h2>cpl_core.database.database_settings_name_enum module<a class="headerlink" href="#module-cpl_core.database.database_settings_name_enum" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.database.database_settings_name_enum">
|
||||
<span id="cpl-core-database-database-settings-name-enum-module"></span><h2>cpl.core.database.database_settings_name_enum module<a class="headerlink" href="#module-cpl.core.database.database_settings_name_enum" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.database_settings_name_enum.</span></span><span class="sig-name descname"><span class="pre">DatabaseSettingsNameEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.database.database_settings_name_enum.</span></span><span class="sig-name descname"><span class="pre">DatabaseSettingsNameEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
||||
<p>An enumeration.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.auth_plugin">
|
||||
<span class="sig-name descname"><span class="pre">auth_plugin</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'AuthPlugin'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.auth_plugin" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum.auth_plugin">
|
||||
<span class="sig-name descname"><span class="pre">auth_plugin</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'AuthPlugin'</span></em><a class="headerlink" href="#cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum.auth_plugin" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.buffered">
|
||||
<span class="sig-name descname"><span class="pre">buffered</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Buffered'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.buffered" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum.buffered">
|
||||
<span class="sig-name descname"><span class="pre">buffered</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Buffered'</span></em><a class="headerlink" href="#cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum.buffered" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.charset">
|
||||
<span class="sig-name descname"><span class="pre">charset</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Charset'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.charset" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum.charset">
|
||||
<span class="sig-name descname"><span class="pre">charset</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Charset'</span></em><a class="headerlink" href="#cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum.charset" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.database">
|
||||
<span class="sig-name descname"><span class="pre">database</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Database'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.database" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum.database">
|
||||
<span class="sig-name descname"><span class="pre">database</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Database'</span></em><a class="headerlink" href="#cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum.database" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.host">
|
||||
<span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Host'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.host" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum.host">
|
||||
<span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Host'</span></em><a class="headerlink" href="#cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum.host" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.password">
|
||||
<span class="sig-name descname"><span class="pre">password</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Password'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.password" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum.password">
|
||||
<span class="sig-name descname"><span class="pre">password</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Password'</span></em><a class="headerlink" href="#cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum.password" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.port">
|
||||
<span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Port'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.port" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum.port">
|
||||
<span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Port'</span></em><a class="headerlink" href="#cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum.port" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.use_unicode">
|
||||
<span class="sig-name descname"><span class="pre">use_unicode</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UseUnicode'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.use_unicode" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum.use_unicode">
|
||||
<span class="sig-name descname"><span class="pre">use_unicode</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UseUnicode'</span></em><a class="headerlink" href="#cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum.use_unicode" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.user">
|
||||
<span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'User'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.user" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum.user">
|
||||
<span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'User'</span></em><a class="headerlink" href="#cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum.user" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.database.table_abc">
|
||||
<span id="cpl-core-database-table-abc-module"></span><h2>cpl_core.database.table_abc module<a class="headerlink" href="#module-cpl_core.database.table_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.database.table_abc">
|
||||
<span id="cpl-core-database-table-abc-module"></span><h2>cpl.core.database.table_abc module<a class="headerlink" href="#module-cpl.core.database.table_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.table_abc.TableABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.table_abc.</span></span><span class="sig-name descname"><span class="pre">TableABC</span></span><a class="headerlink" href="#cpl_core.database.table_abc.TableABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.table_abc.TableABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.database.table_abc.</span></span><span class="sig-name descname"><span class="pre">TableABC</span></span><a class="headerlink" href="#cpl.core.database.table_abc.TableABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.table_abc.TableABC.created_at">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#cpl_core.database.table_abc.TableABC.created_at" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.table_abc.TableABC.created_at">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#cpl.core.database.table_abc.TableABC.created_at" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.table_abc.TableABC.delete_string">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete_string</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.database.table_abc.TableABC.delete_string" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.table_abc.TableABC.delete_string">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete_string</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.database.table_abc.TableABC.delete_string" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.table_abc.TableABC.insert_string">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">insert_string</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.database.table_abc.TableABC.insert_string" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.table_abc.TableABC.insert_string">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">insert_string</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.database.table_abc.TableABC.insert_string" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.table_abc.TableABC.modified_at">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">modified_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#cpl_core.database.table_abc.TableABC.modified_at" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.table_abc.TableABC.modified_at">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">modified_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#cpl.core.database.table_abc.TableABC.modified_at" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.table_abc.TableABC.udpate_string">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udpate_string</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.database.table_abc.TableABC.udpate_string" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.table_abc.TableABC.udpate_string">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">udpate_string</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.database.table_abc.TableABC.udpate_string" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.database">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_core.database" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.database">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl.core.database" title="Permalink to this heading"></a></h2>
|
||||
<section id="cpl-core-cpl-core">
|
||||
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL core package</p>
|
||||
@@ -356,24 +356,24 @@
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.database.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.database.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_core.database.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl.core.database.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_core.database.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl.core.database.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_core.database.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.database.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl.core.database.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
@@ -386,8 +386,8 @@
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_core.console.html" class="btn btn-neutral float-left" title="cpl_core.console package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_core.database.connection.html" class="btn btn-neutral float-right" title="cpl_core.database.connection package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.core.console.html" class="btn btn-neutral float-left" title="cpl.core.console package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl.core.database.connection.html" class="btn btn-neutral float-right" title="cpl.core.database.connection package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
416
docs/build/html/cpl_core.dependency_injection.html
vendored
416
docs/build/html/cpl_core.dependency_injection.html
vendored
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_core.dependency_injection package — Common Python Library documentation</title>
|
||||
<title>cpl.core.dependency_injection package — Common Python Library documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -19,8 +19,8 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="cpl_core.environment package" href="cpl_core.environment.html" />
|
||||
<link rel="prev" title="cpl_core.database.context package" href="cpl_core.database.context.html" />
|
||||
<link rel="next" title="cpl.core.environment package" href="cpl.core.environment.html" />
|
||||
<link rel="prev" title="cpl.core.database.context package" href="cpl.core.database.context.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -48,66 +48,66 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html">cpl_core.database package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.dependency_injection package</a><ul>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl.core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.application.html">cpl.core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.configuration.html">cpl.core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.console.html">cpl.core.console package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.database.html">cpl.core.database package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.core.dependency_injection package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.scope">cpl_core.dependency_injection.scope module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.scope.Scope"><code class="docutils literal notranslate"><span class="pre">Scope</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection.scope">cpl.core.dependency_injection.scope module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.scope.Scope"><code class="docutils literal notranslate"><span class="pre">Scope</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.scope_abc">cpl_core.dependency_injection.scope_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="docutils literal notranslate"><span class="pre">ScopeABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection.scope_abc">cpl.core.dependency_injection.scope_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC"><code class="docutils literal notranslate"><span class="pre">ScopeABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.scope_builder">cpl_core.dependency_injection.scope_builder module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.scope_builder.ScopeBuilder"><code class="docutils literal notranslate"><span class="pre">ScopeBuilder</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection.scope_builder">cpl.core.dependency_injection.scope_builder module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.scope_builder.ScopeBuilder"><code class="docutils literal notranslate"><span class="pre">ScopeBuilder</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_collection">cpl_core.dependency_injection.service_collection module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection.ServiceCollection"><code class="docutils literal notranslate"><span class="pre">ServiceCollection</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection.service_collection">cpl.core.dependency_injection.service_collection module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.service_collection.ServiceCollection"><code class="docutils literal notranslate"><span class="pre">ServiceCollection</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_collection_abc">cpl_core.dependency_injection.service_collection_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="docutils literal notranslate"><span class="pre">ServiceCollectionABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection.service_collection_abc">cpl.core.dependency_injection.service_collection_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="docutils literal notranslate"><span class="pre">ServiceCollectionABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_descriptor">cpl_core.dependency_injection.service_descriptor module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor"><code class="docutils literal notranslate"><span class="pre">ServiceDescriptor</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection.service_descriptor">cpl.core.dependency_injection.service_descriptor module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.service_descriptor.ServiceDescriptor"><code class="docutils literal notranslate"><span class="pre">ServiceDescriptor</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_lifetime_enum">cpl_core.dependency_injection.service_lifetime_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><code class="docutils literal notranslate"><span class="pre">ServiceLifetimeEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection.service_lifetime_enum">cpl.core.dependency_injection.service_lifetime_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><code class="docutils literal notranslate"><span class="pre">ServiceLifetimeEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_provider">cpl_core.dependency_injection.service_provider module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider.ServiceProvider"><code class="docutils literal notranslate"><span class="pre">ServiceProvider</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection.service_provider">cpl.core.dependency_injection.service_provider module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.service_provider.ServiceProvider"><code class="docutils literal notranslate"><span class="pre">ServiceProvider</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_provider_abc">cpl_core.dependency_injection.service_provider_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="docutils literal notranslate"><span class="pre">ServiceProviderABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection.service_provider_abc">cpl.core.dependency_injection.service_provider_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="docutils literal notranslate"><span class="pre">ServiceProviderABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.log.html">cpl_core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_mail.html">cpl_mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.environment.html">cpl.core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.log.html">cpl.core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mail.html">cpl.mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.pipes.html">cpl.core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.time.html">cpl.core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.utils.html">cpl.core.utils package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -125,10 +125,10 @@
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl_core.dependency_injection package</li>
|
||||
<li class="breadcrumb-item"><a href="cpl.core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl.core.dependency_injection package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_core.dependency_injection.rst.txt" rel="nofollow"> View page source</a>
|
||||
<a href="_sources/cpl.core.dependency_injection.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -137,28 +137,28 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="cpl-core-dependency-injection-package">
|
||||
<h1>cpl_core.dependency_injection package<a class="headerlink" href="#cpl-core-dependency-injection-package" title="Permalink to this heading"></a></h1>
|
||||
<h1>cpl.core.dependency_injection package<a class="headerlink" href="#cpl-core-dependency-injection-package" title="Permalink to this heading"></a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection.scope">
|
||||
<span id="cpl-core-dependency-injection-scope-module"></span><h2>cpl_core.dependency_injection.scope module<a class="headerlink" href="#module-cpl_core.dependency_injection.scope" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection.scope">
|
||||
<span id="cpl-core-dependency-injection-scope-module"></span><h2>cpl.core.dependency_injection.scope module<a class="headerlink" href="#module-cpl.core.dependency_injection.scope" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.scope.Scope">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.scope.</span></span><span class="sig-name descname"><span class="pre">Scope</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.scope.Scope" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScopeABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.scope.Scope">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.scope.</span></span><span class="sig-name descname"><span class="pre">Scope</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.scope.Scope" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScopeABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.scope.Scope.dispose">
|
||||
<span class="sig-name descname"><span class="pre">dispose</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.scope.Scope.dispose" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.scope.Scope.dispose">
|
||||
<span class="sig-name descname"><span class="pre">dispose</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.scope.Scope.dispose" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets service_provider to None</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.scope.Scope.service_provider">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">service_provider</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></em><a class="headerlink" href="#cpl_core.dependency_injection.scope.Scope.service_provider" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.scope.Scope.service_provider">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">service_provider</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></em><a class="headerlink" href="#cpl.core.dependency_injection.scope.Scope.service_provider" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns to service provider of scope</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -166,25 +166,25 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection.scope_abc">
|
||||
<span id="cpl-core-dependency-injection-scope-abc-module"></span><h2>cpl_core.dependency_injection.scope_abc module<a class="headerlink" href="#module-cpl_core.dependency_injection.scope_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection.scope_abc">
|
||||
<span id="cpl-core-dependency-injection-scope-abc-module"></span><h2>cpl.core.dependency_injection.scope_abc module<a class="headerlink" href="#module-cpl.core.dependency_injection.scope_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.scope_abc.ScopeABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.scope_abc.</span></span><span class="sig-name descname"><span class="pre">ScopeABC</span></span><a class="headerlink" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.scope_abc.ScopeABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.scope_abc.</span></span><span class="sig-name descname"><span class="pre">ScopeABC</span></span><a class="headerlink" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<p>ABC for the class <a class="reference internal" href="#cpl_core.dependency_injection.scope.Scope" title="cpl_core.dependency_injection.scope.Scope"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope.Scope</span></code></a></p>
|
||||
<p>ABC for the class <a class="reference internal" href="#cpl.core.dependency_injection.scope.Scope" title="cpl.core.dependency_injection.scope.Scope"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.scope.Scope</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.scope_abc.ScopeABC.dispose">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dispose</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.scope_abc.ScopeABC.dispose" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.scope_abc.ScopeABC.dispose">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dispose</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.scope_abc.ScopeABC.dispose" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets service_provider to None</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.scope_abc.ScopeABC.service_provider">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">service_provider</span></span><a class="headerlink" href="#cpl_core.dependency_injection.scope_abc.ScopeABC.service_provider" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.scope_abc.ScopeABC.service_provider">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">service_provider</span></span><a class="headerlink" href="#cpl.core.dependency_injection.scope_abc.ScopeABC.service_provider" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns to service provider of scope</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -192,19 +192,19 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection.scope_builder">
|
||||
<span id="cpl-core-dependency-injection-scope-builder-module"></span><h2>cpl_core.dependency_injection.scope_builder module<a class="headerlink" href="#module-cpl_core.dependency_injection.scope_builder" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection.scope_builder">
|
||||
<span id="cpl-core-dependency-injection-scope-builder-module"></span><h2>cpl.core.dependency_injection.scope_builder module<a class="headerlink" href="#module-cpl.core.dependency_injection.scope_builder" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.scope_builder.ScopeBuilder">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.scope_builder.</span></span><span class="sig-name descname"><span class="pre">ScopeBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.scope_builder.ScopeBuilder" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.scope_builder.ScopeBuilder">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.scope_builder.</span></span><span class="sig-name descname"><span class="pre">ScopeBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.scope_builder.ScopeBuilder" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>Class to build <a class="reference internal" href="#cpl_core.dependency_injection.scope.Scope" title="cpl_core.dependency_injection.scope.Scope"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope.Scope</span></code></a></p>
|
||||
<p>Class to build <a class="reference internal" href="#cpl.core.dependency_injection.scope.Scope" title="cpl.core.dependency_injection.scope.Scope"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.scope.Scope</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.scope_builder.ScopeBuilder.build">
|
||||
<span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.scope_builder.ScopeBuilder.build" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.scope_builder.ScopeBuilder.build">
|
||||
<span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></span><a class="headerlink" href="#cpl.core.dependency_injection.scope_builder.ScopeBuilder.build" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns scope</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope.Scope" title="cpl_core.dependency_injection.scope.Scope"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope.Scope</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl.core.dependency_injection.scope.Scope" title="cpl.core.dependency_injection.scope.Scope"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.scope.Scope</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -212,20 +212,20 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection.service_collection">
|
||||
<span id="cpl-core-dependency-injection-service-collection-module"></span><h2>cpl_core.dependency_injection.service_collection module<a class="headerlink" href="#module-cpl_core.dependency_injection.service_collection" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection.service_collection">
|
||||
<span id="cpl-core-dependency-injection-service-collection-module"></span><h2>cpl.core.dependency_injection.service_collection module<a class="headerlink" href="#module-cpl.core.dependency_injection.service_collection" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_collection.</span></span><span class="sig-name descname"><span class="pre">ServiceCollection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceCollectionABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection.ServiceCollection">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.service_collection.</span></span><span class="sig-name descname"><span class="pre">ServiceCollection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_abc.ConfigurationABC" title="cpl.core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection.ServiceCollection" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceCollectionABC</span></code></a></p>
|
||||
<p>Representation of the collection of services</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_db_context">
|
||||
<span class="sig-name descname"><span class="pre">add_db_context</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_context_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_db_context" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection.ServiceCollection.add_db_context">
|
||||
<span class="sig-name descname"><span class="pre">add_db_context</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_context_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context_abc.DatabaseContextABC" title="cpl.core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.database.html#cpl.core.database.database_settings.DatabaseSettings" title="cpl.core.database.database_settings.DatabaseSettings"><span class="pre">DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection.ServiceCollection.add_db_context" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds database context</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>db_context: Type[<a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database context</p>
|
||||
<dt>db_context: Type[<a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context_abc.DatabaseContextABC" title="cpl.core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database context</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
@@ -233,20 +233,20 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_logging">
|
||||
<span class="sig-name descname"><span class="pre">add_logging</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_logging" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection.ServiceCollection.add_logging">
|
||||
<span class="sig-name descname"><span class="pre">add_logging</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection.ServiceCollection.add_logging" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds the CPL internal logger</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_pipes">
|
||||
<span class="sig-name descname"><span class="pre">add_pipes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_pipes" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection.ServiceCollection.add_pipes">
|
||||
<span class="sig-name descname"><span class="pre">add_pipes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection.ServiceCollection.add_pipes" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds the CPL internal pipes as transient</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_scoped">
|
||||
<span class="sig-name descname"><span class="pre">add_scoped</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_scoped" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection.ServiceCollection.add_scoped">
|
||||
<span class="sig-name descname"><span class="pre">add_scoped</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection.ServiceCollection.add_scoped" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with scoped lifetime</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -256,14 +256,14 @@
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_singleton">
|
||||
<span class="sig-name descname"><span class="pre">add_singleton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_singleton" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection.ServiceCollection.add_singleton">
|
||||
<span class="sig-name descname"><span class="pre">add_singleton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection.ServiceCollection.add_singleton" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with singleton lifetime</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -273,14 +273,14 @@
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_transient">
|
||||
<span class="sig-name descname"><span class="pre">add_transient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_transient" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection.ServiceCollection.add_transient">
|
||||
<span class="sig-name descname"><span class="pre">add_transient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection.ServiceCollection.add_transient" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with transient lifetime</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -290,17 +290,17 @@
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.build_service_provider">
|
||||
<span class="sig-name descname"><span class="pre">build_service_provider</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.build_service_provider" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection.ServiceCollection.build_service_provider">
|
||||
<span class="sig-name descname"><span class="pre">build_service_provider</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection.ServiceCollection.build_service_provider" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates instance of the service provider</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -308,20 +308,20 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection.service_collection_abc">
|
||||
<span id="cpl-core-dependency-injection-service-collection-abc-module"></span><h2>cpl_core.dependency_injection.service_collection_abc module<a class="headerlink" href="#module-cpl_core.dependency_injection.service_collection_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection.service_collection_abc">
|
||||
<span id="cpl-core-dependency-injection-service-collection-abc-module"></span><h2>cpl.core.dependency_injection.service_collection_abc module<a class="headerlink" href="#module-cpl.core.dependency_injection.service_collection_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_collection_abc.</span></span><span class="sig-name descname"><span class="pre">ServiceCollectionABC</span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.service_collection_abc.</span></span><span class="sig-name descname"><span class="pre">ServiceCollectionABC</span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<p>ABC for the class <a class="reference internal" href="#cpl_core.dependency_injection.service_collection.ServiceCollection" title="cpl_core.dependency_injection.service_collection.ServiceCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection.ServiceCollection</span></code></a></p>
|
||||
<p>ABC for the class <a class="reference internal" href="#cpl.core.dependency_injection.service_collection.ServiceCollection" title="cpl.core.dependency_injection.service_collection.ServiceCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_collection.ServiceCollection</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_db_context">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_db_context</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_context_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_db_context" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_db_context">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_db_context</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_context_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context_abc.DatabaseContextABC" title="cpl.core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.database.html#cpl.core.database.database_settings.DatabaseSettings" title="cpl.core.database.database_settings.DatabaseSettings"><span class="pre">DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_db_context" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds database context</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>db_context: Type[<a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database context</p>
|
||||
<dt>db_context: Type[<a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context_abc.DatabaseContextABC" title="cpl.core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database context</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
@@ -329,26 +329,26 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_discord">
|
||||
<span class="sig-name descname"><span class="pre">add_discord</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_discord" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_discord">
|
||||
<span class="sig-name descname"><span class="pre">add_discord</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_discord" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds the CPL discord</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_logging">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_logging</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_logging" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_logging">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_logging</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_logging" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds the CPL internal logger</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_pipes">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_pipes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_pipes" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_pipes">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_pipes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_pipes" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds the CPL internal pipes as transient</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_scoped</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_scoped</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with scoped lifetime</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -358,14 +358,14 @@
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_singleton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_singleton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with singleton lifetime</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -375,14 +375,14 @@
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_transient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_transient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with transient lifetime</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -392,23 +392,23 @@
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_translation">
|
||||
<span class="sig-name descname"><span class="pre">add_translation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_translation" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_translation">
|
||||
<span class="sig-name descname"><span class="pre">add_translation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_translation" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds the CPL translation</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.build_service_provider">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_service_provider</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.build_service_provider" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.build_service_provider">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_service_provider</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.build_service_provider" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates instance of the service provider</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -416,97 +416,97 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection.service_descriptor">
|
||||
<span id="cpl-core-dependency-injection-service-descriptor-module"></span><h2>cpl_core.dependency_injection.service_descriptor module<a class="headerlink" href="#module-cpl_core.dependency_injection.service_descriptor" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection.service_descriptor">
|
||||
<span id="cpl-core-dependency-injection-service-descriptor-module"></span><h2>cpl.core.dependency_injection.service_descriptor module<a class="headerlink" href="#module-cpl.core.dependency_injection.service_descriptor" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_descriptor.</span></span><span class="sig-name descname"><span class="pre">ServiceDescriptor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">implementation</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">object</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lifetime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><span class="pre">ServiceLifetimeEnum</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_descriptor.ServiceDescriptor">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.service_descriptor.</span></span><span class="sig-name descname"><span class="pre">ServiceDescriptor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">implementation</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">object</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lifetime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><span class="pre">ServiceLifetimeEnum</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_descriptor.ServiceDescriptor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>Descriptor of a service</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>implementation: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>, Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code>]]</dt><dd><p>Object or type of service</p>
|
||||
</dd>
|
||||
<dt>lifetime: <a class="reference internal" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum</span></code></a></dt><dd><p>Lifetime of the service</p>
|
||||
<dt>lifetime: <a class="reference internal" href="#cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum</span></code></a></dt><dd><p>Lifetime of the service</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.base_type">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">base_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.base_type" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_descriptor.ServiceDescriptor.base_type">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">base_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span></em><a class="headerlink" href="#cpl.core.dependency_injection.service_descriptor.ServiceDescriptor.base_type" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.implementation">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">implementation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">object</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.implementation" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_descriptor.ServiceDescriptor.implementation">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">implementation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">object</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl.core.dependency_injection.service_descriptor.ServiceDescriptor.implementation" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.lifetime">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lifetime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><span class="pre">ServiceLifetimeEnum</span></a></em><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.lifetime" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_descriptor.ServiceDescriptor.lifetime">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lifetime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><span class="pre">ServiceLifetimeEnum</span></a></em><a class="headerlink" href="#cpl.core.dependency_injection.service_descriptor.ServiceDescriptor.lifetime" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.service_type">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">service_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.service_type" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_descriptor.ServiceDescriptor.service_type">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">service_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span></em><a class="headerlink" href="#cpl.core.dependency_injection.service_descriptor.ServiceDescriptor.service_type" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection.service_lifetime_enum">
|
||||
<span id="cpl-core-dependency-injection-service-lifetime-enum-module"></span><h2>cpl_core.dependency_injection.service_lifetime_enum module<a class="headerlink" href="#module-cpl_core.dependency_injection.service_lifetime_enum" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection.service_lifetime_enum">
|
||||
<span id="cpl-core-dependency-injection-service-lifetime-enum-module"></span><h2>cpl.core.dependency_injection.service_lifetime_enum module<a class="headerlink" href="#module-cpl.core.dependency_injection.service_lifetime_enum" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_lifetime_enum.</span></span><span class="sig-name descname"><span class="pre">ServiceLifetimeEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.service_lifetime_enum.</span></span><span class="sig-name descname"><span class="pre">ServiceLifetimeEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
||||
<p>An enumeration.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.scoped">
|
||||
<span class="sig-name descname"><span class="pre">scoped</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.scoped" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.scoped">
|
||||
<span class="sig-name descname"><span class="pre">scoped</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.scoped" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.singleton">
|
||||
<span class="sig-name descname"><span class="pre">singleton</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.singleton" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.singleton">
|
||||
<span class="sig-name descname"><span class="pre">singleton</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.singleton" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.transient">
|
||||
<span class="sig-name descname"><span class="pre">transient</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.transient" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.transient">
|
||||
<span class="sig-name descname"><span class="pre">transient</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.transient" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection.service_provider">
|
||||
<span id="cpl-core-dependency-injection-service-provider-module"></span><h2>cpl_core.dependency_injection.service_provider module<a class="headerlink" href="#module-cpl_core.dependency_injection.service_provider" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection.service_provider">
|
||||
<span id="cpl-core-dependency-injection-service-provider-module"></span><h2>cpl.core.dependency_injection.service_provider module<a class="headerlink" href="#module-cpl.core.dependency_injection.service_provider" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_provider.</span></span><span class="sig-name descname"><span class="pre">ServiceProvider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_descriptors</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor" title="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor"><span class="pre">cpl_core.dependency_injection.service_descriptor.ServiceDescriptor</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">DatabaseContextABC</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceProviderABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider.ServiceProvider">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.service_provider.</span></span><span class="sig-name descname"><span class="pre">ServiceProvider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_descriptors</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.core.dependency_injection.service_descriptor.ServiceDescriptor" title="cpl.core.dependency_injection.service_descriptor.ServiceDescriptor"><span class="pre">cpl.core.dependency_injection.service_descriptor.ServiceDescriptor</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_abc.ConfigurationABC" title="cpl.core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context_abc.DatabaseContextABC" title="cpl.core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">DatabaseContextABC</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider.ServiceProvider" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceProviderABC</span></code></a></p>
|
||||
<p>Provider for the services</p>
|
||||
<section id="parameter">
|
||||
<h3>Parameter<a class="headerlink" href="#parameter" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>service_descriptors: list[<a class="reference internal" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor" title="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_descriptor.ServiceDescriptor</span></code></a>]</dt><dd><p>Descriptor of the service</p>
|
||||
<dt>service_descriptors: list[<a class="reference internal" href="#cpl.core.dependency_injection.service_descriptor.ServiceDescriptor" title="cpl.core.dependency_injection.service_descriptor.ServiceDescriptor"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_descriptor.ServiceDescriptor</span></code></a>]</dt><dd><p>Descriptor of the service</p>
|
||||
</dd>
|
||||
<dt>config: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></code></a></dt><dd><p>CPL Configuration</p>
|
||||
<dt>config: <a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_abc.ConfigurationABC" title="cpl.core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.configuration.configuration_abc.ConfigurationABC</span></code></a></dt><dd><p>CPL Configuration</p>
|
||||
</dd>
|
||||
<dt>db_context: Optional[<a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database representation</p>
|
||||
<dt>db_context: Optional[<a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context_abc.DatabaseContextABC" title="cpl.core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database representation</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.build_by_signature">
|
||||
<span class="sig-name descname"><span class="pre">build_by_signature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sig</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Signature</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.build_by_signature" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider.ServiceProvider.build_by_signature">
|
||||
<span class="sig-name descname"><span class="pre">build_by_signature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sig</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Signature</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider.ServiceProvider.build_by_signature" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.build_service">
|
||||
<span class="sig-name descname"><span class="pre">build_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.build_service" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider.ServiceProvider.build_service">
|
||||
<span class="sig-name descname"><span class="pre">build_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider.ServiceProvider.build_service" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates instance of given type</p>
|
||||
<section id="id1">
|
||||
<h4>Parameter<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h4>
|
||||
@@ -526,26 +526,26 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.create_scope">
|
||||
<span class="sig-name descname"><span class="pre">create_scope</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.create_scope" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider.ServiceProvider.create_scope">
|
||||
<span class="sig-name descname"><span class="pre">create_scope</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider.ServiceProvider.create_scope" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates a service scope</p>
|
||||
<section id="id2">
|
||||
<h4>Returns<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></p>
|
||||
<div><p>Object of type <a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.scope_abc.ScopeABC</span></code></a></p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.get_service">
|
||||
<span class="sig-name descname"><span class="pre">get_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.get_service" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider.ServiceProvider.get_service">
|
||||
<span class="sig-name descname"><span class="pre">get_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider.ServiceProvider.get_service" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns instance of given type</p>
|
||||
<section id="id3">
|
||||
<h4>Parameter<a class="headerlink" href="#id3" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -553,20 +553,20 @@
|
||||
<section id="id4">
|
||||
<h4>Returns<a class="headerlink" href="#id4" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><p>Object of type Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
|
||||
<div><p>Object of type Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.type.T</span></code>]</p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.get_services">
|
||||
<span class="sig-name descname"><span class="pre">get_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.get_services" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider.ServiceProvider.get_services">
|
||||
<span class="sig-name descname"><span class="pre">get_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider.ServiceProvider.get_services" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns instance of given type</p>
|
||||
<section id="id5">
|
||||
<h4>Parameter<a class="headerlink" href="#id5" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -574,20 +574,20 @@
|
||||
<section id="id6">
|
||||
<h4>Returns<a class="headerlink" href="#id6" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><p>Object of type list[Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
|
||||
<div><p>Object of type list[Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.type.T</span></code>]</p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.set_scope">
|
||||
<span class="sig-name descname"><span class="pre">set_scope</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.set_scope" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider.ServiceProvider.set_scope">
|
||||
<span class="sig-name descname"><span class="pre">set_scope</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider.ServiceProvider.set_scope" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets the scope of service provider</p>
|
||||
<section id="id7">
|
||||
<h4>Parameter<a class="headerlink" href="#id7" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></dt><dd><p>Service scope</p>
|
||||
<dt>Object of type <a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.scope_abc.ScopeABC</span></code></a></dt><dd><p>Service scope</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -598,21 +598,21 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection.service_provider_abc">
|
||||
<span id="cpl-core-dependency-injection-service-provider-abc-module"></span><h2>cpl_core.dependency_injection.service_provider_abc module<a class="headerlink" href="#module-cpl_core.dependency_injection.service_provider_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection.service_provider_abc">
|
||||
<span id="cpl-core-dependency-injection-service-provider-abc-module"></span><h2>cpl.core.dependency_injection.service_provider_abc module<a class="headerlink" href="#module-cpl.core.dependency_injection.service_provider_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_provider_abc.</span></span><span class="sig-name descname"><span class="pre">ServiceProviderABC</span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.service_provider_abc.</span></span><span class="sig-name descname"><span class="pre">ServiceProviderABC</span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<p>ABC for the class <a class="reference internal" href="#cpl_core.dependency_injection.service_provider.ServiceProvider" title="cpl_core.dependency_injection.service_provider.ServiceProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_provider.ServiceProvider</span></code></a></p>
|
||||
<p>ABC for the class <a class="reference internal" href="#cpl.core.dependency_injection.service_provider.ServiceProvider" title="cpl.core.dependency_injection.service_provider.ServiceProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_provider.ServiceProvider</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_by_signature">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_by_signature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sig</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Signature</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_by_signature" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.build_by_signature">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_by_signature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sig</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Signature</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.build_by_signature" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_service">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_service" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.build_service">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.build_service" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates instance of given type</p>
|
||||
<section id="id8">
|
||||
<h3>Parameter<a class="headerlink" href="#id8" title="Permalink to this heading"></a></h3>
|
||||
@@ -632,26 +632,26 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.create_scope">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_scope</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.create_scope" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.create_scope">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_scope</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.create_scope" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates a service scope</p>
|
||||
<section id="id10">
|
||||
<h3>Returns<a class="headerlink" href="#id10" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></p>
|
||||
<div><p>Object of type <a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.scope_abc.ScopeABC</span></code></a></p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_service">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_service" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.get_service">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.get_service" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns instance of given type</p>
|
||||
<section id="id11">
|
||||
<h3>Parameter<a class="headerlink" href="#id11" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -659,20 +659,20 @@
|
||||
<section id="id12">
|
||||
<h3>Returns<a class="headerlink" href="#id12" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><p>Object of type Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
|
||||
<div><p>Object of type Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.type.T</span></code>]</p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_services">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_services" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.get_services">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.get_services" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns instance of given type</p>
|
||||
<section id="id13">
|
||||
<h3>Parameter<a class="headerlink" href="#id13" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -680,14 +680,14 @@
|
||||
<section id="id14">
|
||||
<h3>Returns<a class="headerlink" href="#id14" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><p>Object of type list[Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
|
||||
<div><p>Object of type list[Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.type.T</span></code>]</p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.inject">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">inject</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.inject" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.inject">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">inject</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.inject" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Decorator to allow injection into static and class methods</p>
|
||||
<section id="id15">
|
||||
<h3>Parameter<a class="headerlink" href="#id15" title="Permalink to this heading"></a></h3>
|
||||
@@ -704,19 +704,19 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.set_global_provider">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_global_provider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.set_global_provider" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.set_global_provider">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_global_provider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.set_global_provider" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.set_scope">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_scope</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.set_scope" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.set_scope">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_scope</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.set_scope" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets the scope of service provider</p>
|
||||
<section id="id17">
|
||||
<h3>Parameter<a class="headerlink" href="#id17" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></dt><dd><p>Service scope</p>
|
||||
<dt>Object of type <a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.scope_abc.ScopeABC</span></code></a></dt><dd><p>Service scope</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -726,8 +726,8 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_core.dependency_injection" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl.core.dependency_injection" title="Permalink to this heading"></a></h2>
|
||||
<section id="cpl-core-cpl-core">
|
||||
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL core package</p>
|
||||
@@ -743,24 +743,24 @@
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_core.dependency_injection.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl.core.dependency_injection.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_core.dependency_injection.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl.core.dependency_injection.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_core.dependency_injection.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl.core.dependency_injection.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
@@ -773,8 +773,8 @@
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_core.database.context.html" class="btn btn-neutral float-left" title="cpl_core.database.context package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_core.environment.html" class="btn btn-neutral float-right" title="cpl_core.environment package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.core.database.context.html" class="btn btn-neutral float-left" title="cpl.core.database.context package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl.core.environment.html" class="btn btn-neutral float-right" title="cpl.core.environment package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
214
docs/build/html/cpl_core.environment.html
vendored
214
docs/build/html/cpl_core.environment.html
vendored
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_core.environment package — Common Python Library documentation</title>
|
||||
<title>cpl.core.environment package — Common Python Library documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -19,8 +19,8 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="cpl_core.log package" href="cpl_core.log.html" />
|
||||
<link rel="prev" title="cpl_core.dependency_injection package" href="cpl_core.dependency_injection.html" />
|
||||
<link rel="next" title="cpl.core.log package" href="cpl.core.log.html" />
|
||||
<link rel="prev" title="cpl.core.dependency_injection package" href="cpl.core.dependency_injection.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -48,42 +48,42 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html">cpl_core.database package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.environment package</a><ul>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl.core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.application.html">cpl.core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.configuration.html">cpl.core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.console.html">cpl.core.console package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.database.html">cpl.core.database package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.dependency_injection.html">cpl.core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.core.environment package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.environment.application_environment">cpl_core.environment.application_environment module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.environment.application_environment.ApplicationEnvironment"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironment</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.environment.application_environment">cpl.core.environment.application_environment module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.environment.application_environment.ApplicationEnvironment"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironment</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.environment.application_environment_abc">cpl_core.environment.application_environment_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironmentABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.environment.application_environment_abc">cpl.core.environment.application_environment_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironmentABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.environment.environment_name_enum">cpl_core.environment.environment_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.environment.environment_name_enum.EnvironmentNameEnum"><code class="docutils literal notranslate"><span class="pre">EnvironmentNameEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.environment.environment_name_enum">cpl.core.environment.environment_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.environment.environment_name_enum.EnvironmentNameEnum"><code class="docutils literal notranslate"><span class="pre">EnvironmentNameEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.environment">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.environment">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.environment.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.environment.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.log.html">cpl_core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_mail.html">cpl_mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.log.html">cpl.core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mail.html">cpl.mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.pipes.html">cpl.core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.time.html">cpl.core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.utils.html">cpl.core.utils package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -101,10 +101,10 @@
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl_core.environment package</li>
|
||||
<li class="breadcrumb-item"><a href="cpl.core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl.core.environment package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_core.environment.rst.txt" rel="nofollow"> View page source</a>
|
||||
<a href="_sources/cpl.core.environment.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -113,59 +113,59 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="cpl-core-environment-package">
|
||||
<h1>cpl_core.environment package<a class="headerlink" href="#cpl-core-environment-package" title="Permalink to this heading"></a></h1>
|
||||
<h1>cpl.core.environment package<a class="headerlink" href="#cpl-core-environment-package" title="Permalink to this heading"></a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_core.environment.application_environment">
|
||||
<span id="cpl-core-environment-application-environment-module"></span><h2>cpl_core.environment.application_environment module<a class="headerlink" href="#module-cpl_core.environment.application_environment" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.environment.application_environment">
|
||||
<span id="cpl-core-environment-application-environment-module"></span><h2>cpl.core.environment.application_environment module<a class="headerlink" href="#module-cpl.core.environment.application_environment" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment.ApplicationEnvironment">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.environment.application_environment.</span></span><span class="sig-name descname"><span class="pre">ApplicationEnvironment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.environment.environment_name_enum.EnvironmentNameEnum" title="cpl_core.environment.environment_name_enum.EnvironmentNameEnum"><span class="pre">EnvironmentNameEnum</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">EnvironmentNameEnum.production</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.environment.application_environment.ApplicationEnvironment" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplicationEnvironmentABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment.ApplicationEnvironment">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.environment.application_environment.</span></span><span class="sig-name descname"><span class="pre">ApplicationEnvironment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.environment.environment_name_enum.EnvironmentNameEnum" title="cpl.core.environment.environment_name_enum.EnvironmentNameEnum"><span class="pre">EnvironmentNameEnum</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">EnvironmentNameEnum.production</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.environment.application_environment.ApplicationEnvironment" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplicationEnvironmentABC</span></code></a></p>
|
||||
<p>Represents environment of the application</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><p>name: <a class="reference internal" href="#cpl_core.environment.environment_name_enum.EnvironmentNameEnum" title="cpl_core.environment.environment_name_enum.EnvironmentNameEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.environment.environment_name_enum.EnvironmentNameEnum</span></code></a></p>
|
||||
<dt>Parameter:</dt><dd><p>name: <a class="reference internal" href="#cpl.core.environment.environment_name_enum.EnvironmentNameEnum" title="cpl.core.environment.environment_name_enum.EnvironmentNameEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.environment.environment_name_enum.EnvironmentNameEnum</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment.ApplicationEnvironment.application_name">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">application_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.environment.application_environment.ApplicationEnvironment.application_name" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment.ApplicationEnvironment.application_name">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">application_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.environment.application_environment.ApplicationEnvironment.application_name" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment.ApplicationEnvironment.customer">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customer</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.environment.application_environment.ApplicationEnvironment.customer" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment.ApplicationEnvironment.customer">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customer</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.environment.application_environment.ApplicationEnvironment.customer" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment.ApplicationEnvironment.date_time_now">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date_time_now</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#cpl_core.environment.application_environment.ApplicationEnvironment.date_time_now" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment.ApplicationEnvironment.date_time_now">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date_time_now</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#cpl.core.environment.application_environment.ApplicationEnvironment.date_time_now" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment.ApplicationEnvironment.end_time">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">end_time</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#cpl_core.environment.application_environment.ApplicationEnvironment.end_time" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment.ApplicationEnvironment.end_time">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">end_time</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#cpl.core.environment.application_environment.ApplicationEnvironment.end_time" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment.ApplicationEnvironment.environment_name">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">environment_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.environment.application_environment.ApplicationEnvironment.environment_name" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment.ApplicationEnvironment.environment_name">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">environment_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.environment.application_environment.ApplicationEnvironment.environment_name" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment.ApplicationEnvironment.host_name">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">host_name</span></span><a class="headerlink" href="#cpl_core.environment.application_environment.ApplicationEnvironment.host_name" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment.ApplicationEnvironment.host_name">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">host_name</span></span><a class="headerlink" href="#cpl.core.environment.application_environment.ApplicationEnvironment.host_name" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment.ApplicationEnvironment.runtime_directory">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">runtime_directory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.environment.application_environment.ApplicationEnvironment.runtime_directory" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment.ApplicationEnvironment.runtime_directory">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">runtime_directory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.environment.application_environment.ApplicationEnvironment.runtime_directory" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment.ApplicationEnvironment.set_runtime_directory">
|
||||
<span class="sig-name descname"><span class="pre">set_runtime_directory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">runtime_directory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.environment.application_environment.ApplicationEnvironment.set_runtime_directory" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment.ApplicationEnvironment.set_runtime_directory">
|
||||
<span class="sig-name descname"><span class="pre">set_runtime_directory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">runtime_directory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.environment.application_environment.ApplicationEnvironment.set_runtime_directory" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets the current runtime directory</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -177,8 +177,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment.ApplicationEnvironment.set_working_directory">
|
||||
<span class="sig-name descname"><span class="pre">set_working_directory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">working_directory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.environment.application_environment.ApplicationEnvironment.set_working_directory" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment.ApplicationEnvironment.set_working_directory">
|
||||
<span class="sig-name descname"><span class="pre">set_working_directory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">working_directory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.environment.application_environment.ApplicationEnvironment.set_working_directory" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets the current working directory</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -190,63 +190,63 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment.ApplicationEnvironment.start_time">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">start_time</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#cpl_core.environment.application_environment.ApplicationEnvironment.start_time" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment.ApplicationEnvironment.start_time">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">start_time</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#cpl.core.environment.application_environment.ApplicationEnvironment.start_time" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment.ApplicationEnvironment.working_directory">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">working_directory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.environment.application_environment.ApplicationEnvironment.working_directory" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment.ApplicationEnvironment.working_directory">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">working_directory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.environment.application_environment.ApplicationEnvironment.working_directory" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.environment.application_environment_abc">
|
||||
<span id="cpl-core-environment-application-environment-abc-module"></span><h2>cpl_core.environment.application_environment_abc module<a class="headerlink" href="#module-cpl_core.environment.application_environment_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.environment.application_environment_abc">
|
||||
<span id="cpl-core-environment-application-environment-abc-module"></span><h2>cpl.core.environment.application_environment_abc module<a class="headerlink" href="#module-cpl.core.environment.application_environment_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.environment.application_environment_abc.</span></span><span class="sig-name descname"><span class="pre">ApplicationEnvironmentABC</span></span><a class="headerlink" href="#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.environment.application_environment_abc.</span></span><span class="sig-name descname"><span class="pre">ApplicationEnvironmentABC</span></span><a class="headerlink" href="#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<p>ABC of the class <a class="reference internal" href="#cpl_core.environment.application_environment.ApplicationEnvironment" title="cpl_core.environment.application_environment.ApplicationEnvironment"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.environment.application_environment.ApplicationEnvironment</span></code></a></p>
|
||||
<p>ABC of the class <a class="reference internal" href="#cpl.core.environment.application_environment.ApplicationEnvironment" title="cpl.core.environment.application_environment.ApplicationEnvironment"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.environment.application_environment.ApplicationEnvironment</span></code></a></p>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.application_name">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">application_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.application_name" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.application_name">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">application_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.application_name" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.customer">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customer</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.customer" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.customer">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">customer</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.customer" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.date_time_now">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date_time_now</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.date_time_now" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.date_time_now">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date_time_now</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.date_time_now" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.end_time">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">end_time</span></span><a class="headerlink" href="#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.end_time" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.end_time">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">end_time</span></span><a class="headerlink" href="#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.end_time" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.environment_name">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">environment_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.environment_name" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.environment_name">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">environment_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.environment_name" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.host_name">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">host_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.host_name" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.host_name">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">host_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.host_name" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.runtime_directory">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">runtime_directory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.runtime_directory" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.runtime_directory">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">runtime_directory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.runtime_directory" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.set_runtime_directory">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_runtime_directory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">runtime_directory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.set_runtime_directory" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.set_runtime_directory">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_runtime_directory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">runtime_directory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.set_runtime_directory" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets the current runtime directory</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -258,8 +258,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.set_working_directory">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_working_directory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">working_directory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.set_working_directory" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.set_working_directory">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_working_directory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">working_directory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.set_working_directory" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets the current working directory</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -271,50 +271,50 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.start_time">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">start_time</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.start_time" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.start_time">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">start_time</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.start_time" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.working_directory">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">working_directory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.working_directory" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.working_directory">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">working_directory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC.working_directory" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.environment.environment_name_enum">
|
||||
<span id="cpl-core-environment-environment-name-enum-module"></span><h2>cpl_core.environment.environment_name_enum module<a class="headerlink" href="#module-cpl_core.environment.environment_name_enum" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.environment.environment_name_enum">
|
||||
<span id="cpl-core-environment-environment-name-enum-module"></span><h2>cpl.core.environment.environment_name_enum module<a class="headerlink" href="#module-cpl.core.environment.environment_name_enum" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.environment_name_enum.EnvironmentNameEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.environment.environment_name_enum.</span></span><span class="sig-name descname"><span class="pre">EnvironmentNameEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.environment.environment_name_enum.EnvironmentNameEnum" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.environment_name_enum.EnvironmentNameEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.environment.environment_name_enum.</span></span><span class="sig-name descname"><span class="pre">EnvironmentNameEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.environment.environment_name_enum.EnvironmentNameEnum" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
||||
<p>An enumeration.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.environment_name_enum.EnvironmentNameEnum.development">
|
||||
<span class="sig-name descname"><span class="pre">development</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'development'</span></em><a class="headerlink" href="#cpl_core.environment.environment_name_enum.EnvironmentNameEnum.development" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.environment_name_enum.EnvironmentNameEnum.development">
|
||||
<span class="sig-name descname"><span class="pre">development</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'development'</span></em><a class="headerlink" href="#cpl.core.environment.environment_name_enum.EnvironmentNameEnum.development" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.environment_name_enum.EnvironmentNameEnum.production">
|
||||
<span class="sig-name descname"><span class="pre">production</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'production'</span></em><a class="headerlink" href="#cpl_core.environment.environment_name_enum.EnvironmentNameEnum.production" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.environment_name_enum.EnvironmentNameEnum.production">
|
||||
<span class="sig-name descname"><span class="pre">production</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'production'</span></em><a class="headerlink" href="#cpl.core.environment.environment_name_enum.EnvironmentNameEnum.production" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.environment_name_enum.EnvironmentNameEnum.staging">
|
||||
<span class="sig-name descname"><span class="pre">staging</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'staging'</span></em><a class="headerlink" href="#cpl_core.environment.environment_name_enum.EnvironmentNameEnum.staging" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.environment_name_enum.EnvironmentNameEnum.staging">
|
||||
<span class="sig-name descname"><span class="pre">staging</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'staging'</span></em><a class="headerlink" href="#cpl.core.environment.environment_name_enum.EnvironmentNameEnum.staging" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.environment_name_enum.EnvironmentNameEnum.testing">
|
||||
<span class="sig-name descname"><span class="pre">testing</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'testing'</span></em><a class="headerlink" href="#cpl_core.environment.environment_name_enum.EnvironmentNameEnum.testing" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.environment_name_enum.EnvironmentNameEnum.testing">
|
||||
<span class="sig-name descname"><span class="pre">testing</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'testing'</span></em><a class="headerlink" href="#cpl.core.environment.environment_name_enum.EnvironmentNameEnum.testing" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.environment">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_core.environment" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.environment">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl.core.environment" title="Permalink to this heading"></a></h2>
|
||||
<section id="cpl-core-cpl-core">
|
||||
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL core package</p>
|
||||
@@ -330,24 +330,24 @@
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.environment.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.environment.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.environment.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.environment.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_core.environment.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl.core.environment.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_core.environment.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl.core.environment.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.environment.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_core.environment.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.environment.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl.core.environment.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
@@ -360,8 +360,8 @@
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_core.dependency_injection.html" class="btn btn-neutral float-left" title="cpl_core.dependency_injection package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_core.log.html" class="btn btn-neutral float-right" title="cpl_core.log package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.core.dependency_injection.html" class="btn btn-neutral float-left" title="cpl.core.dependency_injection package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl.core.log.html" class="btn btn-neutral float-right" title="cpl.core.log package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
1048
docs/build/html/cpl_core.html
vendored
1048
docs/build/html/cpl_core.html
vendored
File diff suppressed because it is too large
Load Diff
260
docs/build/html/cpl_core.logging.html
vendored
260
docs/build/html/cpl_core.logging.html
vendored
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_core.log package — Common Python Library documentation</title>
|
||||
<title>cpl.core.log package — Common Python Library documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -19,8 +19,8 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="cpl_mail package" href="cpl_mail.html" />
|
||||
<link rel="prev" title="cpl_core.environment package" href="cpl_core.environment.html" />
|
||||
<link rel="next" title="cpl.mail package" href="cpl.mail.html" />
|
||||
<link rel="prev" title="cpl.core.environment package" href="cpl.core.environment.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -48,50 +48,50 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html">cpl_core.database package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.log package</a><ul>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl.core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.application.html">cpl.core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.configuration.html">cpl.core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.console.html">cpl.core.console package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.database.html">cpl.core.database package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.dependency_injection.html">cpl.core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.environment.html">cpl.core.environment package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.core.log package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.log.logger_abc">cpl_core.log.logger_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.log.logger_abc.LoggerABC"><code class="docutils literal notranslate"><span class="pre">LoggerABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.log.logger_abc">cpl.core.log.logger_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.log.logger_abc.LoggerABC"><code class="docutils literal notranslate"><span class="pre">LoggerABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.log.logger_service">cpl_core.log.logger_service module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.log.logger_service.Logger"><code class="docutils literal notranslate"><span class="pre">Logger</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.log.logger_service">cpl.core.log.logger_service module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.log.logger_service.Logger"><code class="docutils literal notranslate"><span class="pre">Logger</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.log.logging_level_enum">cpl_core.log.logging_level_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.log.logging_level_enum.LoggingLevelEnum"><code class="docutils literal notranslate"><span class="pre">LoggingLevelEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.log.logging_level_enum">cpl.core.log.logging_level_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.log.logging_level_enum.LoggingLevelEnum"><code class="docutils literal notranslate"><span class="pre">LoggingLevelEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.log.logging_settings">cpl_core.log.logging_settings module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.log.logging_settings.LoggingSettings"><code class="docutils literal notranslate"><span class="pre">LoggingSettings</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.log.logging_settings">cpl.core.log.logging_settings module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.log.logging_settings.LoggingSettings"><code class="docutils literal notranslate"><span class="pre">LoggingSettings</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.log.logging_settings_name_enum">cpl_core.log.logging_settings_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.log.logging_settings_name_enum.LoggingSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">LoggingSettingsNameEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.log.logging_settings_name_enum">cpl.core.log.logging_settings_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.log.logging_settings_name_enum.LoggingSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">LoggingSettingsNameEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.log">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.log">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.log.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.log.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_mail.html">cpl_mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mail.html">cpl.mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.pipes.html">cpl.core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.time.html">cpl.core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.utils.html">cpl.core.utils package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -109,10 +109,10 @@
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl_core.log package</li>
|
||||
<li class="breadcrumb-item"><a href="cpl.core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl.core.log package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_core.log.rst.txt" rel="nofollow"> View page source</a>
|
||||
<a href="_sources/cpl.core.log.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -121,20 +121,20 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="cpl-core-logging-package">
|
||||
<h1>cpl_core.log package<a class="headerlink" href="#cpl-core-logging-package" title="Permalink to this heading"></a></h1>
|
||||
<h1>cpl.core.log package<a class="headerlink" href="#cpl-core-logging-package" title="Permalink to this heading"></a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_core.log.logger_abc">
|
||||
<span id="cpl-core-logging-logger-abc-module"></span><h2>cpl_core.log.logger_abc module<a class="headerlink" href="#module-cpl_core.log.logger_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.log.logger_abc">
|
||||
<span id="cpl-core-logging-logger-abc-module"></span><h2>cpl.core.log.logger_abc module<a class="headerlink" href="#module-cpl.core.log.logger_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logger_abc.LoggerABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.log.logger_abc.</span></span><span class="sig-name descname"><span class="pre">LoggerABC</span></span><a class="headerlink" href="#cpl_core.log.logger_abc.LoggerABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logger_abc.LoggerABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.log.logger_abc.</span></span><span class="sig-name descname"><span class="pre">LoggerABC</span></span><a class="headerlink" href="#cpl.core.log.logger_abc.LoggerABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<p>ABC for <a class="reference internal" href="#cpl_core.log.logger_service.Logger" title="cpl_core.log.logger_service.Logger"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.log.logger_service.Logger</span></code></a></p>
|
||||
<p>ABC for <a class="reference internal" href="#cpl.core.log.logger_service.Logger" title="cpl.core.log.logger_service.Logger"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.log.logger_service.Logger</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logger_abc.LoggerABC.debug">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">debug</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.log.logger_abc.LoggerABC.debug" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logger_abc.LoggerABC.debug">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">debug</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.log.logger_abc.LoggerABC.debug" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Writes a debug message</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -148,8 +148,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logger_abc.LoggerABC.error">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Exception</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.log.logger_abc.LoggerABC.error" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logger_abc.LoggerABC.error">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Exception</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.log.logger_abc.LoggerABC.error" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Writes an error</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -165,8 +165,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logger_abc.LoggerABC.fatal">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fatal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Exception</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.log.logger_abc.LoggerABC.fatal" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logger_abc.LoggerABC.fatal">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fatal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Exception</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.log.logger_abc.LoggerABC.fatal" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Writes an error and ends the program</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -182,8 +182,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logger_abc.LoggerABC.header">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.log.logger_abc.LoggerABC.header" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logger_abc.LoggerABC.header">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.log.logger_abc.LoggerABC.header" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Writes a header message</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -195,8 +195,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logger_abc.LoggerABC.info">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.log.logger_abc.LoggerABC.info" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logger_abc.LoggerABC.info">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.log.logger_abc.LoggerABC.info" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Writes an information</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -210,8 +210,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logger_abc.LoggerABC.trace">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.log.logger_abc.LoggerABC.trace" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logger_abc.LoggerABC.trace">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.log.logger_abc.LoggerABC.trace" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Writes a trace message</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -225,8 +225,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logger_abc.LoggerABC.warn">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">warn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.log.logger_abc.LoggerABC.warn" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logger_abc.LoggerABC.warn">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">warn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.log.logger_abc.LoggerABC.warn" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Writes an warning</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -242,33 +242,33 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.log.logger_service">
|
||||
<span id="cpl-core-logging-logger-service-module"></span><h2>cpl_core.log.logger_service module<a class="headerlink" href="#module-cpl_core.log.logger_service" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.log.logger_service">
|
||||
<span id="cpl-core-logging-logger-service-module"></span><h2>cpl.core.log.logger_service module<a class="headerlink" href="#module-cpl.core.log.logger_service" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logger_service.Logger">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.log.logger_service.</span></span><span class="sig-name descname"><span class="pre">Logger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">logging_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.log.logging_settings.LoggingSettings" title="cpl_core.log.logging_settings.LoggingSettings"><span class="pre">LoggingSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">time_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.time.html#cpl_core.time.time_format_settings.TimeFormatSettings" title="cpl_core.time.time_format_settings.TimeFormatSettings"><span class="pre">TimeFormatSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.log.logger_service.Logger" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.log.logger_abc.LoggerABC" title="cpl_core.log.logger_abc.LoggerABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoggerABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logger_service.Logger">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.log.logger_service.</span></span><span class="sig-name descname"><span class="pre">Logger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">logging_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.log.logging_settings.LoggingSettings" title="cpl.core.log.logging_settings.LoggingSettings"><span class="pre">LoggingSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">time_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.time.html#cpl.core.time.time_format_settings.TimeFormatSettings" title="cpl.core.time.time_format_settings.TimeFormatSettings"><span class="pre">TimeFormatSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.environment.html#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.log.logger_service.Logger" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.log.logger_abc.LoggerABC" title="cpl.core.log.logger_abc.LoggerABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoggerABC</span></code></a></p>
|
||||
<p>Service for logging</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>logging_settings: <a class="reference internal" href="#cpl_core.log.logging_settings.LoggingSettings" title="cpl_core.log.logging_settings.LoggingSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.log.logging_settings.LoggingSettings</span></code></a></dt><dd><p>Settings for the logger</p>
|
||||
<dt>logging_settings: <a class="reference internal" href="#cpl.core.log.logging_settings.LoggingSettings" title="cpl.core.log.logging_settings.LoggingSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.log.logging_settings.LoggingSettings</span></code></a></dt><dd><p>Settings for the logger</p>
|
||||
</dd>
|
||||
<dt>time_format: <a class="reference internal" href="cpl_core.time.html#cpl_core.time.time_format_settings.TimeFormatSettings" title="cpl_core.time.time_format_settings.TimeFormatSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.time.time_format_settings.TimeFormatSettings</span></code></a></dt><dd><p>Time format settings</p>
|
||||
<dt>time_format: <a class="reference internal" href="cpl.core.time.html#cpl.core.time.time_format_settings.TimeFormatSettings" title="cpl.core.time.time_format_settings.TimeFormatSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.time.time_format_settings.TimeFormatSettings</span></code></a></dt><dd><p>Time format settings</p>
|
||||
</dd>
|
||||
<dt>env: <a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></code></a></dt><dd><p>Environment of the application</p>
|
||||
<dt>env: <a class="reference internal" href="cpl.core.environment.html#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC</span></code></a></dt><dd><p>Environment of the application</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logger_service.Logger.create">
|
||||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_core.log.logger_service.Logger.create" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logger_service.Logger.create">
|
||||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#cpl.core.log.logger_service.Logger.create" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates path tree and logfile</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logger_service.Logger.debug">
|
||||
<span class="sig-name descname"><span class="pre">debug</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.log.logger_service.Logger.debug" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logger_service.Logger.debug">
|
||||
<span class="sig-name descname"><span class="pre">debug</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.log.logger_service.Logger.debug" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Writes a debug message</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -282,8 +282,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logger_service.Logger.error">
|
||||
<span class="sig-name descname"><span class="pre">error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Exception</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.log.logger_service.Logger.error" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logger_service.Logger.error">
|
||||
<span class="sig-name descname"><span class="pre">error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Exception</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.log.logger_service.Logger.error" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Writes an error</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -299,8 +299,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logger_service.Logger.fatal">
|
||||
<span class="sig-name descname"><span class="pre">fatal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Exception</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.log.logger_service.Logger.fatal" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logger_service.Logger.fatal">
|
||||
<span class="sig-name descname"><span class="pre">fatal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Exception</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.log.logger_service.Logger.fatal" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Writes an error and ends the program</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -316,8 +316,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logger_service.Logger.header">
|
||||
<span class="sig-name descname"><span class="pre">header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.log.logger_service.Logger.header" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logger_service.Logger.header">
|
||||
<span class="sig-name descname"><span class="pre">header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.log.logger_service.Logger.header" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Writes a header message</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -329,8 +329,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logger_service.Logger.info">
|
||||
<span class="sig-name descname"><span class="pre">info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.log.logger_service.Logger.info" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logger_service.Logger.info">
|
||||
<span class="sig-name descname"><span class="pre">info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.log.logger_service.Logger.info" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Writes an information</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -344,8 +344,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logger_service.Logger.trace">
|
||||
<span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.log.logger_service.Logger.trace" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logger_service.Logger.trace">
|
||||
<span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.log.logger_service.Logger.trace" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Writes a trace message</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -359,8 +359,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logger_service.Logger.warn">
|
||||
<span class="sig-name descname"><span class="pre">warn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.log.logger_service.Logger.warn" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logger_service.Logger.warn">
|
||||
<span class="sig-name descname"><span class="pre">warn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.log.logger_service.Logger.warn" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Writes an warning</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -376,113 +376,113 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.log.logging_level_enum">
|
||||
<span id="cpl-core-logging-logging-level-enum-module"></span><h2>cpl_core.log.logging_level_enum module<a class="headerlink" href="#module-cpl_core.log.logging_level_enum" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.log.logging_level_enum">
|
||||
<span id="cpl-core-logging-logging-level-enum-module"></span><h2>cpl.core.log.logging_level_enum module<a class="headerlink" href="#module-cpl.core.log.logging_level_enum" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logging_level_enum.LoggingLevelEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.log.logging_level_enum.</span></span><span class="sig-name descname"><span class="pre">LoggingLevelEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.log.logging_level_enum.LoggingLevelEnum" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logging_level_enum.LoggingLevelEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.log.logging_level_enum.</span></span><span class="sig-name descname"><span class="pre">LoggingLevelEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.log.logging_level_enum.LoggingLevelEnum" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
||||
<p>An enumeration.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logging_level_enum.LoggingLevelEnum.DEBUG">
|
||||
<span class="sig-name descname"><span class="pre">DEBUG</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5</span></em><a class="headerlink" href="#cpl_core.log.logging_level_enum.LoggingLevelEnum.DEBUG" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logging_level_enum.LoggingLevelEnum.DEBUG">
|
||||
<span class="sig-name descname"><span class="pre">DEBUG</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5</span></em><a class="headerlink" href="#cpl.core.log.logging_level_enum.LoggingLevelEnum.DEBUG" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logging_level_enum.LoggingLevelEnum.ERROR">
|
||||
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#cpl_core.log.logging_level_enum.LoggingLevelEnum.ERROR" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logging_level_enum.LoggingLevelEnum.ERROR">
|
||||
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#cpl.core.log.logging_level_enum.LoggingLevelEnum.ERROR" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logging_level_enum.LoggingLevelEnum.FATAL">
|
||||
<span class="sig-name descname"><span class="pre">FATAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#cpl_core.log.logging_level_enum.LoggingLevelEnum.FATAL" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logging_level_enum.LoggingLevelEnum.FATAL">
|
||||
<span class="sig-name descname"><span class="pre">FATAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#cpl.core.log.logging_level_enum.LoggingLevelEnum.FATAL" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logging_level_enum.LoggingLevelEnum.INFO">
|
||||
<span class="sig-name descname"><span class="pre">INFO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#cpl_core.log.logging_level_enum.LoggingLevelEnum.INFO" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logging_level_enum.LoggingLevelEnum.INFO">
|
||||
<span class="sig-name descname"><span class="pre">INFO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#cpl.core.log.logging_level_enum.LoggingLevelEnum.INFO" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logging_level_enum.LoggingLevelEnum.OFF">
|
||||
<span class="sig-name descname"><span class="pre">OFF</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#cpl_core.log.logging_level_enum.LoggingLevelEnum.OFF" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logging_level_enum.LoggingLevelEnum.OFF">
|
||||
<span class="sig-name descname"><span class="pre">OFF</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#cpl.core.log.logging_level_enum.LoggingLevelEnum.OFF" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logging_level_enum.LoggingLevelEnum.TRACE">
|
||||
<span class="sig-name descname"><span class="pre">TRACE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">6</span></em><a class="headerlink" href="#cpl_core.log.logging_level_enum.LoggingLevelEnum.TRACE" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logging_level_enum.LoggingLevelEnum.TRACE">
|
||||
<span class="sig-name descname"><span class="pre">TRACE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">6</span></em><a class="headerlink" href="#cpl.core.log.logging_level_enum.LoggingLevelEnum.TRACE" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logging_level_enum.LoggingLevelEnum.WARN">
|
||||
<span class="sig-name descname"><span class="pre">WARN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#cpl_core.log.logging_level_enum.LoggingLevelEnum.WARN" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logging_level_enum.LoggingLevelEnum.WARN">
|
||||
<span class="sig-name descname"><span class="pre">WARN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#cpl.core.log.logging_level_enum.LoggingLevelEnum.WARN" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.log.logging_settings">
|
||||
<span id="cpl-core-logging-logging-settings-module"></span><h2>cpl_core.log.logging_settings module<a class="headerlink" href="#module-cpl_core.log.logging_settings" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.log.logging_settings">
|
||||
<span id="cpl-core-logging-logging-settings-module"></span><h2>cpl.core.log.logging_settings module<a class="headerlink" href="#module-cpl.core.log.logging_settings" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logging_settings.LoggingSettings">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.log.logging_settings.</span></span><span class="sig-name descname"><span class="pre">LoggingSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_log_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.log.logging_level_enum.LoggingLevelEnum" title="cpl_core.log.logging_level_enum.LoggingLevelEnum"><span class="pre">LoggingLevelEnum</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_log_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.log.logging_level_enum.LoggingLevelEnum" title="cpl_core.log.logging_level_enum.LoggingLevelEnum"><span class="pre">LoggingLevelEnum</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.log.logging_settings.LoggingSettings" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logging_settings.LoggingSettings">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.log.logging_settings.</span></span><span class="sig-name descname"><span class="pre">LoggingSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_log_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.log.logging_level_enum.LoggingLevelEnum" title="cpl.core.log.logging_level_enum.LoggingLevelEnum"><span class="pre">LoggingLevelEnum</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_log_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.log.logging_level_enum.LoggingLevelEnum" title="cpl.core.log.logging_level_enum.LoggingLevelEnum"><span class="pre">LoggingLevelEnum</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.log.logging_settings.LoggingSettings" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
|
||||
<p>Representation of logging settings</p>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logging_settings.LoggingSettings.console">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">console</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.log.logging_level_enum.LoggingLevelEnum" title="cpl_core.log.logging_level_enum.LoggingLevelEnum"><span class="pre">LoggingLevelEnum</span></a></em><a class="headerlink" href="#cpl_core.log.logging_settings.LoggingSettings.console" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logging_settings.LoggingSettings.console">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">console</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl.core.log.logging_level_enum.LoggingLevelEnum" title="cpl.core.log.logging_level_enum.LoggingLevelEnum"><span class="pre">LoggingLevelEnum</span></a></em><a class="headerlink" href="#cpl.core.log.logging_settings.LoggingSettings.console" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logging_settings.LoggingSettings.filename">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">filename</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.log.logging_settings.LoggingSettings.filename" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logging_settings.LoggingSettings.filename">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">filename</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.log.logging_settings.LoggingSettings.filename" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logging_settings.LoggingSettings.level">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">level</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.log.logging_level_enum.LoggingLevelEnum" title="cpl_core.log.logging_level_enum.LoggingLevelEnum"><span class="pre">LoggingLevelEnum</span></a></em><a class="headerlink" href="#cpl_core.log.logging_settings.LoggingSettings.level" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logging_settings.LoggingSettings.level">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">level</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl.core.log.logging_level_enum.LoggingLevelEnum" title="cpl.core.log.logging_level_enum.LoggingLevelEnum"><span class="pre">LoggingLevelEnum</span></a></em><a class="headerlink" href="#cpl.core.log.logging_settings.LoggingSettings.level" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logging_settings.LoggingSettings.path">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.log.logging_settings.LoggingSettings.path" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logging_settings.LoggingSettings.path">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.log.logging_settings.LoggingSettings.path" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.log.logging_settings_name_enum">
|
||||
<span id="cpl-core-logging-logging-settings-name-enum-module"></span><h2>cpl_core.log.logging_settings_name_enum module<a class="headerlink" href="#module-cpl_core.log.logging_settings_name_enum" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.log.logging_settings_name_enum">
|
||||
<span id="cpl-core-logging-logging-settings-name-enum-module"></span><h2>cpl.core.log.logging_settings_name_enum module<a class="headerlink" href="#module-cpl.core.log.logging_settings_name_enum" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logging_settings_name_enum.LoggingSettingsNameEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.log.logging_settings_name_enum.</span></span><span class="sig-name descname"><span class="pre">LoggingSettingsNameEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.log.logging_settings_name_enum.LoggingSettingsNameEnum" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logging_settings_name_enum.LoggingSettingsNameEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.log.logging_settings_name_enum.</span></span><span class="sig-name descname"><span class="pre">LoggingSettingsNameEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.log.logging_settings_name_enum.LoggingSettingsNameEnum" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
||||
<p>An enumeration.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logging_settings_name_enum.LoggingSettingsNameEnum.console_level">
|
||||
<span class="sig-name descname"><span class="pre">console_level</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ConsoleLogLevel'</span></em><a class="headerlink" href="#cpl_core.log.logging_settings_name_enum.LoggingSettingsNameEnum.console_level" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logging_settings_name_enum.LoggingSettingsNameEnum.console_level">
|
||||
<span class="sig-name descname"><span class="pre">console_level</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ConsoleLogLevel'</span></em><a class="headerlink" href="#cpl.core.log.logging_settings_name_enum.LoggingSettingsNameEnum.console_level" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logging_settings_name_enum.LoggingSettingsNameEnum.file_level">
|
||||
<span class="sig-name descname"><span class="pre">file_level</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FileLogLevel'</span></em><a class="headerlink" href="#cpl_core.log.logging_settings_name_enum.LoggingSettingsNameEnum.file_level" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logging_settings_name_enum.LoggingSettingsNameEnum.file_level">
|
||||
<span class="sig-name descname"><span class="pre">file_level</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FileLogLevel'</span></em><a class="headerlink" href="#cpl.core.log.logging_settings_name_enum.LoggingSettingsNameEnum.file_level" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logging_settings_name_enum.LoggingSettingsNameEnum.filename">
|
||||
<span class="sig-name descname"><span class="pre">filename</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Filename'</span></em><a class="headerlink" href="#cpl_core.log.logging_settings_name_enum.LoggingSettingsNameEnum.filename" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logging_settings_name_enum.LoggingSettingsNameEnum.filename">
|
||||
<span class="sig-name descname"><span class="pre">filename</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Filename'</span></em><a class="headerlink" href="#cpl.core.log.logging_settings_name_enum.LoggingSettingsNameEnum.filename" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.logging_settings_name_enum.LoggingSettingsNameEnum.path">
|
||||
<span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Path'</span></em><a class="headerlink" href="#cpl_core.log.logging_settings_name_enum.LoggingSettingsNameEnum.path" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.logging_settings_name_enum.LoggingSettingsNameEnum.path">
|
||||
<span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Path'</span></em><a class="headerlink" href="#cpl.core.log.logging_settings_name_enum.LoggingSettingsNameEnum.path" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.log">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_core.log" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.log">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl.core.log" title="Permalink to this heading"></a></h2>
|
||||
<section id="cpl-core-cpl-core">
|
||||
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL core package</p>
|
||||
@@ -498,24 +498,24 @@
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.log.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.log.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.log.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.log.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_core.log.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl.core.log.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_core.log.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl.core.log.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.log.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_core.log.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.log.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl.core.log.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
@@ -528,8 +528,8 @@
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_core.environment.html" class="btn btn-neutral float-left" title="cpl_core.environment package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_mail.html" class="btn btn-neutral float-right" title="cpl_mail package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.core.environment.html" class="btn btn-neutral float-left" title="cpl.core.environment package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl.mail.html" class="btn btn-neutral float-right" title="cpl.mail package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
244
docs/build/html/cpl_core.mailing.html
vendored
244
docs/build/html/cpl_core.mailing.html
vendored
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_mail package — Common Python Library documentation</title>
|
||||
<title>cpl.mail package — Common Python Library documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -19,8 +19,8 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="cpl_core.pipes package" href="cpl_core.pipes.html" />
|
||||
<link rel="prev" title="cpl_core.log package" href="cpl_core.log.html" />
|
||||
<link rel="next" title="cpl.core.pipes package" href="cpl.core.pipes.html" />
|
||||
<link rel="prev" title="cpl.core.log package" href="cpl.core.log.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -48,50 +48,50 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html">cpl_core.database package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.log.html">cpl_core.log package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_mail package</a><ul>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl.core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.application.html">cpl.core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.configuration.html">cpl.core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.console.html">cpl.core.console package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.database.html">cpl.core.database package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.dependency_injection.html">cpl.core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.environment.html">cpl.core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.log.html">cpl.core.log package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.mail package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_mail.email">cpl_mail.email module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_mail.email.EMail"><code class="docutils literal notranslate"><span class="pre">EMail</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.mail.email">cpl.mail.email module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.mail.email.EMail"><code class="docutils literal notranslate"><span class="pre">EMail</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_mail.email_client_abc">cpl_mail.email_client_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_mail.email_client_abc.EMailClientABC"><code class="docutils literal notranslate"><span class="pre">EMailClientABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.mail.email_client_abc">cpl.mail.email_client_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.mail.email_client_abc.EMailClientABC"><code class="docutils literal notranslate"><span class="pre">EMailClientABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_mail.email_client_service">cpl_mail.email_client_service module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_mail.email_client_service.EMailClient"><code class="docutils literal notranslate"><span class="pre">EMailClient</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.mail.email_client_service">cpl.mail.email_client_service module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.mail.email_client_service.EMailClient"><code class="docutils literal notranslate"><span class="pre">EMailClient</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_mail.email_client_settings">cpl_mail.email_client_settings module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_mail.email_client_settings.EMailClientSettings"><code class="docutils literal notranslate"><span class="pre">EMailClientSettings</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.mail.email_client_settings">cpl.mail.email_client_settings module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.mail.email_client_settings.EMailClientSettings"><code class="docutils literal notranslate"><span class="pre">EMailClientSettings</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_mail.email_client_settings_name_enum">cpl_mail.email_client_settings_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">EMailClientSettingsNameEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.mail.email_client_settings_name_enum">cpl.mail.email_client_settings_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.mail.email_client_settings_name_enum.EMailClientSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">EMailClientSettingsNameEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_mail">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.mail">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_mail.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.mail.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.pipes.html">cpl.core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.time.html">cpl.core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.utils.html">cpl.core.utils package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -109,10 +109,10 @@
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl_mail package</li>
|
||||
<li class="breadcrumb-item"><a href="cpl.core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl.mail package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_mail.rst.txt" rel="nofollow"> View page source</a>
|
||||
<a href="_sources/cpl.mail.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -121,15 +121,15 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="cpl-core-mailing-package">
|
||||
<h1>cpl_mail package<a class="headerlink" href="#cpl-core-mailing-package" title="Permalink to this heading"></a></h1>
|
||||
<h1>cpl.mail package<a class="headerlink" href="#cpl-core-mailing-package" title="Permalink to this heading"></a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_mail.email">
|
||||
<span id="cpl-core-mailing-email-module"></span><h2>cpl_mail.email module<a class="headerlink" href="#module-cpl_mail.email" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.mail.email">
|
||||
<span id="cpl-core-mailing-email-module"></span><h2>cpl.mail.email module<a class="headerlink" href="#module-cpl.mail.email" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email.EMail">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_mail.email.</span></span><span class="sig-name descname"><span class="pre">EMail</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transceiver</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">receiver</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_mail.email.EMail" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email.EMail">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.mail.email.</span></span><span class="sig-name descname"><span class="pre">EMail</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transceiver</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">receiver</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mail.email.EMail" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>Represents an email</p>
|
||||
<dl class="simple">
|
||||
@@ -148,8 +148,8 @@
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email.EMail.add_header">
|
||||
<span class="sig-name descname"><span class="pre">add_header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_mail.email.EMail.add_header" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email.EMail.add_header">
|
||||
<span class="sig-name descname"><span class="pre">add_header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mail.email.EMail.add_header" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds header</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -161,8 +161,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email.EMail.add_receiver">
|
||||
<span class="sig-name descname"><span class="pre">add_receiver</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">receiver</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_mail.email.EMail.add_receiver" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email.EMail.add_receiver">
|
||||
<span class="sig-name descname"><span class="pre">add_receiver</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">receiver</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mail.email.EMail.add_receiver" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds receiver</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -174,13 +174,13 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email.EMail.body">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">body</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_mail.email.EMail.body" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email.EMail.body">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">body</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.mail.email.EMail.body" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email.EMail.check_mail">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">check_mail</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_mail.email.EMail.check_mail" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email.EMail.check_mail">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">check_mail</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl.mail.email.EMail.check_mail" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Checks if an email is valid</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -194,8 +194,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email.EMail.get_content">
|
||||
<span class="sig-name descname"><span class="pre">get_content</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">transceiver</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_mail.email.EMail.get_content" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email.EMail.get_content">
|
||||
<span class="sig-name descname"><span class="pre">get_content</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">transceiver</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mail.email.EMail.get_content" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns the mail as string</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -209,58 +209,58 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email.EMail.header">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">header</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_mail.email.EMail.header" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email.EMail.header">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">header</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.mail.email.EMail.header" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email.EMail.header_list">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">header_list</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_mail.email.EMail.header_list" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email.EMail.header_list">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">header_list</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl.mail.email.EMail.header_list" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email.EMail.receiver">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">receiver</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_mail.email.EMail.receiver" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email.EMail.receiver">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">receiver</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.mail.email.EMail.receiver" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email.EMail.receiver_list">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">receiver_list</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_mail.email.EMail.receiver_list" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email.EMail.receiver_list">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">receiver_list</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl.mail.email.EMail.receiver_list" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email.EMail.subject">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">subject</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_mail.email.EMail.subject" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email.EMail.subject">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">subject</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.mail.email.EMail.subject" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email.EMail.transceiver">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">transceiver</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_mail.email.EMail.transceiver" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email.EMail.transceiver">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">transceiver</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.mail.email.EMail.transceiver" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_mail.email_client_abc">
|
||||
<span id="cpl-core-mailing-email-client-abc-module"></span><h2>cpl_mail.email_client_abc module<a class="headerlink" href="#module-cpl_mail.email_client_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.mail.email_client_abc">
|
||||
<span id="cpl-core-mailing-email-client-abc-module"></span><h2>cpl.mail.email_client_abc module<a class="headerlink" href="#module-cpl.mail.email_client_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email_client_abc.EMailClientABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_mail.email_client_abc.</span></span><span class="sig-name descname"><span class="pre">EMailClientABC</span></span><a class="headerlink" href="#cpl_mail.email_client_abc.EMailClientABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email_client_abc.EMailClientABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.mail.email_client_abc.</span></span><span class="sig-name descname"><span class="pre">EMailClientABC</span></span><a class="headerlink" href="#cpl.mail.email_client_abc.EMailClientABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<p>ABC of <a class="reference internal" href="#cpl_mail.email_client_service.EMailClient" title="cpl_mail.email_client_service.EMailClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_mail.email_client_service.EMailClient</span></code></a></p>
|
||||
<p>ABC of <a class="reference internal" href="#cpl.mail.email_client_service.EMailClient" title="cpl.mail.email_client_service.EMailClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.mail.email_client_service.EMailClient</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email_client_abc.EMailClientABC.connect">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_mail.email_client_abc.EMailClientABC.connect" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email_client_abc.EMailClientABC.connect">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mail.email_client_abc.EMailClientABC.connect" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Connects to server</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email_client_abc.EMailClientABC.send_mail">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">send_mail</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">email</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_mail.email.EMail" title="cpl_mail.email.EMail"><span class="pre">EMail</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_mail.email_client_abc.EMailClientABC.send_mail" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email_client_abc.EMailClientABC.send_mail">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">send_mail</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">email</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.mail.email.EMail" title="cpl.mail.email.EMail"><span class="pre">EMail</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mail.email_client_abc.EMailClientABC.send_mail" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sends email</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>email: <a class="reference internal" href="#cpl_mail.email.EMail" title="cpl_mail.email.EMail"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_mail.email.EMail</span></code></a></dt><dd><p>Object of the E-Mail to send</p>
|
||||
<dt>email: <a class="reference internal" href="#cpl.mail.email.EMail" title="cpl.mail.email.EMail"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.mail.email.EMail</span></code></a></dt><dd><p>Object of the E-Mail to send</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
@@ -270,49 +270,49 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_mail.email_client_service">
|
||||
<span id="cpl-core-mailing-email-client-service-module"></span><h2>cpl_mail.email_client_service module<a class="headerlink" href="#module-cpl_mail.email_client_service" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.mail.email_client_service">
|
||||
<span id="cpl-core-mailing-email-client-service-module"></span><h2>cpl.mail.email_client_service module<a class="headerlink" href="#module-cpl.mail.email_client_service" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email_client_service.EMailClient">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_mail.email_client_service.</span></span><span class="sig-name descname"><span class="pre">EMailClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">environment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.log.html#cpl_core.log.logger_abc.LoggerABC" title="cpl_core.log.logger_abc.LoggerABC"><span class="pre">LoggerABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">mail_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_mail.email_client_settings.EMailClientSettings" title="cpl_mail.email_client_settings.EMailClientSettings"><span class="pre">EMailClientSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_mail.email_client_service.EMailClient" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_mail.email_client_abc.EMailClientABC" title="cpl_mail.email_client_abc.EMailClientABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EMailClientABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email_client_service.EMailClient">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.mail.email_client_service.</span></span><span class="sig-name descname"><span class="pre">EMailClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">environment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.environment.html#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.log.html#cpl.core.log.logger_abc.LoggerABC" title="cpl.core.log.logger_abc.LoggerABC"><span class="pre">LoggerABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">mail_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.mail.email_client_settings.EMailClientSettings" title="cpl.mail.email_client_settings.EMailClientSettings"><span class="pre">EMailClientSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mail.email_client_service.EMailClient" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.mail.email_client_abc.EMailClientABC" title="cpl.mail.email_client_abc.EMailClientABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EMailClientABC</span></code></a></p>
|
||||
<p>Service to send emails</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>environment: <a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></code></a></dt><dd><p>Environment of the application</p>
|
||||
<dt>environment: <a class="reference internal" href="cpl.core.environment.html#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC</span></code></a></dt><dd><p>Environment of the application</p>
|
||||
</dd>
|
||||
<dt>logger: <a class="reference internal" href="cpl_core.log.html#cpl_core.log.logger_abc.LoggerABC" title="cpl_core.log.logger_abc.LoggerABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.log.logger_abc.LoggerABC</span></code></a></dt><dd><p>The logger to use</p>
|
||||
<dt>logger: <a class="reference internal" href="cpl.core.log.html#cpl.core.log.logger_abc.LoggerABC" title="cpl.core.log.logger_abc.LoggerABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.log.logger_abc.LoggerABC</span></code></a></dt><dd><p>The logger to use</p>
|
||||
</dd>
|
||||
<dt>mail_settings: <a class="reference internal" href="#cpl_mail.email_client_settings.EMailClientSettings" title="cpl_mail.email_client_settings.EMailClientSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_mail.email_client_settings.EMailClientSettings</span></code></a></dt><dd><p>Settings for mailing</p>
|
||||
<dt>mail_settings: <a class="reference internal" href="#cpl.mail.email_client_settings.EMailClientSettings" title="cpl.mail.email_client_settings.EMailClientSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.mail.email_client_settings.EMailClientSettings</span></code></a></dt><dd><p>Settings for mailing</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email_client_service.EMailClient.connect">
|
||||
<span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_mail.email_client_service.EMailClient.connect" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email_client_service.EMailClient.connect">
|
||||
<span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mail.email_client_service.EMailClient.connect" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Connects to server</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email_client_service.EMailClient.create">
|
||||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_mail.email_client_service.EMailClient.create" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email_client_service.EMailClient.create">
|
||||
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mail.email_client_service.EMailClient.create" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates connection</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email_client_service.EMailClient.login">
|
||||
<span class="sig-name descname"><span class="pre">login</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_mail.email_client_service.EMailClient.login" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email_client_service.EMailClient.login">
|
||||
<span class="sig-name descname"><span class="pre">login</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mail.email_client_service.EMailClient.login" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Login to server</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email_client_service.EMailClient.send_mail">
|
||||
<span class="sig-name descname"><span class="pre">send_mail</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">email</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_mail.email.EMail" title="cpl_mail.email.EMail"><span class="pre">EMail</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_mail.email_client_service.EMailClient.send_mail" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email_client_service.EMailClient.send_mail">
|
||||
<span class="sig-name descname"><span class="pre">send_mail</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">email</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.mail.email.EMail" title="cpl.mail.email.EMail"><span class="pre">EMail</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mail.email_client_service.EMailClient.send_mail" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sends email</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>email: <a class="reference internal" href="#cpl_mail.email.EMail" title="cpl_mail.email.EMail"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_mail.email.EMail</span></code></a></dt><dd><p>Object of the E-Mail to send</p>
|
||||
<dt>email: <a class="reference internal" href="#cpl.mail.email.EMail" title="cpl.mail.email.EMail"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.mail.email.EMail</span></code></a></dt><dd><p>Object of the E-Mail to send</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
@@ -322,68 +322,68 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_mail.email_client_settings">
|
||||
<span id="cpl-core-mailing-email-client-settings-module"></span><h2>cpl_mail.email_client_settings module<a class="headerlink" href="#module-cpl_mail.email_client_settings" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.mail.email_client_settings">
|
||||
<span id="cpl-core-mailing-email-client-settings-module"></span><h2>cpl.mail.email_client_settings module<a class="headerlink" href="#module-cpl.mail.email_client_settings" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email_client_settings.EMailClientSettings">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_mail.email_client_settings.</span></span><span class="sig-name descname"><span class="pre">EMailClientSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_mail.email_client_settings.EMailClientSettings" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email_client_settings.EMailClientSettings">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.mail.email_client_settings.</span></span><span class="sig-name descname"><span class="pre">EMailClientSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mail.email_client_settings.EMailClientSettings" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
|
||||
<p>Representation of mailing settings</p>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email_client_settings.EMailClientSettings.credentials">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">credentials</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_mail.email_client_settings.EMailClientSettings.credentials" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email_client_settings.EMailClientSettings.credentials">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">credentials</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.mail.email_client_settings.EMailClientSettings.credentials" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email_client_settings.EMailClientSettings.host">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_mail.email_client_settings.EMailClientSettings.host" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email_client_settings.EMailClientSettings.host">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.mail.email_client_settings.EMailClientSettings.host" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email_client_settings.EMailClientSettings.port">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#cpl_mail.email_client_settings.EMailClientSettings.port" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email_client_settings.EMailClientSettings.port">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#cpl.mail.email_client_settings.EMailClientSettings.port" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email_client_settings.EMailClientSettings.user_name">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_mail.email_client_settings.EMailClientSettings.user_name" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email_client_settings.EMailClientSettings.user_name">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.mail.email_client_settings.EMailClientSettings.user_name" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_mail.email_client_settings_name_enum">
|
||||
<span id="cpl-core-mailing-email-client-settings-name-enum-module"></span><h2>cpl_mail.email_client_settings_name_enum module<a class="headerlink" href="#module-cpl_mail.email_client_settings_name_enum" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.mail.email_client_settings_name_enum">
|
||||
<span id="cpl-core-mailing-email-client-settings-name-enum-module"></span><h2>cpl.mail.email_client_settings_name_enum module<a class="headerlink" href="#module-cpl.mail.email_client_settings_name_enum" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_mail.email_client_settings_name_enum.</span></span><span class="sig-name descname"><span class="pre">EMailClientSettingsNameEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email_client_settings_name_enum.EMailClientSettingsNameEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.mail.email_client_settings_name_enum.</span></span><span class="sig-name descname"><span class="pre">EMailClientSettingsNameEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mail.email_client_settings_name_enum.EMailClientSettingsNameEnum" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
||||
<p>An enumeration.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.credentials">
|
||||
<span class="sig-name descname"><span class="pre">credentials</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Credentials'</span></em><a class="headerlink" href="#cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.credentials" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.credentials">
|
||||
<span class="sig-name descname"><span class="pre">credentials</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Credentials'</span></em><a class="headerlink" href="#cpl.mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.credentials" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.host">
|
||||
<span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Host'</span></em><a class="headerlink" href="#cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.host" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.host">
|
||||
<span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Host'</span></em><a class="headerlink" href="#cpl.mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.host" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.port">
|
||||
<span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Port'</span></em><a class="headerlink" href="#cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.port" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.port">
|
||||
<span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Port'</span></em><a class="headerlink" href="#cpl.mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.port" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.user_name">
|
||||
<span class="sig-name descname"><span class="pre">user_name</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UserName'</span></em><a class="headerlink" href="#cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.user_name" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.user_name">
|
||||
<span class="sig-name descname"><span class="pre">user_name</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UserName'</span></em><a class="headerlink" href="#cpl.mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.user_name" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_mail">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_mail" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.mail">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl.mail" title="Permalink to this heading"></a></h2>
|
||||
<section id="cpl-core-cpl-core">
|
||||
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL core package</p>
|
||||
@@ -399,24 +399,24 @@
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_mail.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_mail.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_mail.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.mail.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mail.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_mail.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_mail.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl.mail.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_mail.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_mail.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl.mail.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_mail.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_mail.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.mail.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl.mail.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
@@ -429,8 +429,8 @@
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_core.log.html" class="btn btn-neutral float-left" title="cpl_core.log package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_core.pipes.html" class="btn btn-neutral float-right" title="cpl_core.pipes package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.core.log.html" class="btn btn-neutral float-left" title="cpl.core.log package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl.core.pipes.html" class="btn btn-neutral float-right" title="cpl.core.pipes package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
210
docs/build/html/cpl_core.pipes.html
vendored
210
docs/build/html/cpl_core.pipes.html
vendored
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_core.pipes package — Common Python Library documentation</title>
|
||||
<title>cpl.core.pipes package — Common Python Library documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -19,8 +19,8 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="cpl_core.time package" href="cpl_core.time.html" />
|
||||
<link rel="prev" title="cpl_mail package" href="cpl_mail.html" />
|
||||
<link rel="next" title="cpl.core.time package" href="cpl.core.time.html" />
|
||||
<link rel="prev" title="cpl.mail package" href="cpl.mail.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -48,62 +48,62 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html">cpl_core.database package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.log.html">cpl_core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_mail.html">cpl_mail package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.pipes package</a><ul>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl.core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.application.html">cpl.core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.configuration.html">cpl.core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.console.html">cpl.core.console package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.database.html">cpl.core.database package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.dependency_injection.html">cpl.core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.environment.html">cpl.core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.log.html">cpl.core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mail.html">cpl.mail package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.core.pipes package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.bool_pipe">cpl_core.pipes.bool_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.pipes.bool_pipe.BoolPipe"><code class="docutils literal notranslate"><span class="pre">BoolPipe</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.pipes.bool_pipe">cpl.core.pipes.bool_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.pipes.bool_pipe.BoolPipe"><code class="docutils literal notranslate"><span class="pre">BoolPipe</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.first_char_to_lower_pipe">cpl_core.pipes.first_char_to_lower_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe"><code class="docutils literal notranslate"><span class="pre">FirstCharToLowerPipe</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.pipes.first_char_to_lower_pipe">cpl.core.pipes.first_char_to_lower_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe"><code class="docutils literal notranslate"><span class="pre">FirstCharToLowerPipe</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.first_to_upper_pipe">cpl_core.pipes.first_to_upper_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.pipes.first_to_upper_pipe.FirstToUpperPipe"><code class="docutils literal notranslate"><span class="pre">FirstToUpperPipe</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.pipes.first_to_upper_pipe">cpl.core.pipes.first_to_upper_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.pipes.first_to_upper_pipe.FirstToUpperPipe"><code class="docutils literal notranslate"><span class="pre">FirstToUpperPipe</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.ip_address_pipe">cpl_core.pipes.ip_address_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.pipes.ip_address_pipe.IPAddressPipe"><code class="docutils literal notranslate"><span class="pre">IPAddressPipe</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.pipes.ip_address_pipe">cpl.core.pipes.ip_address_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.pipes.ip_address_pipe.IPAddressPipe"><code class="docutils literal notranslate"><span class="pre">IPAddressPipe</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.pipe_abc">cpl_core.pipes.pipe_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.pipes.pipe_abc.PipeABC"><code class="docutils literal notranslate"><span class="pre">PipeABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.pipes.pipe_abc">cpl.core.pipes.pipe_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.pipes.pipe_abc.PipeABC"><code class="docutils literal notranslate"><span class="pre">PipeABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.to_camel_case_pipe">cpl_core.pipes.to_camel_case_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.pipes.to_camel_case_pipe.ToCamelCasePipe"><code class="docutils literal notranslate"><span class="pre">ToCamelCasePipe</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.pipes.to_camel_case_pipe">cpl.core.pipes.to_camel_case_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.pipes.to_camel_case_pipe.ToCamelCasePipe"><code class="docutils literal notranslate"><span class="pre">ToCamelCasePipe</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.to_snake_case_pipe">cpl_core.pipes.to_snake_case_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.pipes.to_snake_case_pipe.ToSnakeCasePipe"><code class="docutils literal notranslate"><span class="pre">ToSnakeCasePipe</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.pipes.to_snake_case_pipe">cpl.core.pipes.to_snake_case_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.pipes.to_snake_case_pipe.ToSnakeCasePipe"><code class="docutils literal notranslate"><span class="pre">ToSnakeCasePipe</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.version_pipe">cpl_core.pipes.version_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.pipes.version_pipe.VersionPipe"><code class="docutils literal notranslate"><span class="pre">VersionPipe</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.pipes.version_pipe">cpl.core.pipes.version_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.pipes.version_pipe.VersionPipe"><code class="docutils literal notranslate"><span class="pre">VersionPipe</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.pipes">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.pipes.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.pipes.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.time.html">cpl.core.time package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.utils.html">cpl.core.utils package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -121,10 +121,10 @@
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl_core.pipes package</li>
|
||||
<li class="breadcrumb-item"><a href="cpl.core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl.core.pipes package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_core.pipes.rst.txt" rel="nofollow"> View page source</a>
|
||||
<a href="_sources/cpl.core.pipes.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -133,33 +133,33 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="cpl-core-pipes-package">
|
||||
<h1>cpl_core.pipes package<a class="headerlink" href="#cpl-core-pipes-package" title="Permalink to this heading"></a></h1>
|
||||
<h1>cpl.core.pipes package<a class="headerlink" href="#cpl-core-pipes-package" title="Permalink to this heading"></a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_core.pipes.bool_pipe">
|
||||
<span id="cpl-core-pipes-bool-pipe-module"></span><h2>cpl_core.pipes.bool_pipe module<a class="headerlink" href="#module-cpl_core.pipes.bool_pipe" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.pipes.bool_pipe">
|
||||
<span id="cpl-core-pipes-bool-pipe-module"></span><h2>cpl.core.pipes.bool_pipe module<a class="headerlink" href="#module-cpl.core.pipes.bool_pipe" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.bool_pipe.BoolPipe">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.bool_pipe.</span></span><span class="sig-name descname"><span class="pre">BoolPipe</span></span><a class="headerlink" href="#cpl_core.pipes.bool_pipe.BoolPipe" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.pipes.pipe_abc.PipeABC" title="cpl_core.pipes.pipe_abc.PipeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipeABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.bool_pipe.BoolPipe">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.pipes.bool_pipe.</span></span><span class="sig-name descname"><span class="pre">BoolPipe</span></span><a class="headerlink" href="#cpl.core.pipes.bool_pipe.BoolPipe" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.pipes.pipe_abc.PipeABC" title="cpl.core.pipes.pipe_abc.PipeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipeABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.bool_pipe.BoolPipe.transform">
|
||||
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.pipes.bool_pipe.BoolPipe.transform" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.bool_pipe.BoolPipe.transform">
|
||||
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.pipes.bool_pipe.BoolPipe.transform" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.pipes.first_char_to_lower_pipe">
|
||||
<span id="cpl-core-pipes-first-char-to-lower-pipe-module"></span><h2>cpl_core.pipes.first_char_to_lower_pipe module<a class="headerlink" href="#module-cpl_core.pipes.first_char_to_lower_pipe" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.pipes.first_char_to_lower_pipe">
|
||||
<span id="cpl-core-pipes-first-char-to-lower-pipe-module"></span><h2>cpl.core.pipes.first_char_to_lower_pipe module<a class="headerlink" href="#module-cpl.core.pipes.first_char_to_lower_pipe" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.first_char_to_lower_pipe.</span></span><span class="sig-name descname"><span class="pre">FirstCharToLowerPipe</span></span><a class="headerlink" href="#cpl_core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.pipes.pipe_abc.PipeABC" title="cpl_core.pipes.pipe_abc.PipeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipeABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.pipes.first_char_to_lower_pipe.</span></span><span class="sig-name descname"><span class="pre">FirstCharToLowerPipe</span></span><a class="headerlink" href="#cpl.core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.pipes.pipe_abc.PipeABC" title="cpl.core.pipes.pipe_abc.PipeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipeABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe.transform">
|
||||
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">any</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe.transform" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe.transform">
|
||||
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">any</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe.transform" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts first char to lower</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -175,15 +175,15 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.pipes.first_to_upper_pipe">
|
||||
<span id="cpl-core-pipes-first-to-upper-pipe-module"></span><h2>cpl_core.pipes.first_to_upper_pipe module<a class="headerlink" href="#module-cpl_core.pipes.first_to_upper_pipe" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.pipes.first_to_upper_pipe">
|
||||
<span id="cpl-core-pipes-first-to-upper-pipe-module"></span><h2>cpl.core.pipes.first_to_upper_pipe module<a class="headerlink" href="#module-cpl.core.pipes.first_to_upper_pipe" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.first_to_upper_pipe.FirstToUpperPipe">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.first_to_upper_pipe.</span></span><span class="sig-name descname"><span class="pre">FirstToUpperPipe</span></span><a class="headerlink" href="#cpl_core.pipes.first_to_upper_pipe.FirstToUpperPipe" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.pipes.pipe_abc.PipeABC" title="cpl_core.pipes.pipe_abc.PipeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipeABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.first_to_upper_pipe.FirstToUpperPipe">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.pipes.first_to_upper_pipe.</span></span><span class="sig-name descname"><span class="pre">FirstToUpperPipe</span></span><a class="headerlink" href="#cpl.core.pipes.first_to_upper_pipe.FirstToUpperPipe" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.pipes.pipe_abc.PipeABC" title="cpl.core.pipes.pipe_abc.PipeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipeABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.first_to_upper_pipe.FirstToUpperPipe.transform">
|
||||
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.pipes.first_to_upper_pipe.FirstToUpperPipe.transform" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.first_to_upper_pipe.FirstToUpperPipe.transform">
|
||||
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.pipes.first_to_upper_pipe.FirstToUpperPipe.transform" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts first char to upper</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -199,43 +199,43 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.pipes.ip_address_pipe">
|
||||
<span id="cpl-core-pipes-ip-address-pipe-module"></span><h2>cpl_core.pipes.ip_address_pipe module<a class="headerlink" href="#module-cpl_core.pipes.ip_address_pipe" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.pipes.ip_address_pipe">
|
||||
<span id="cpl-core-pipes-ip-address-pipe-module"></span><h2>cpl.core.pipes.ip_address_pipe module<a class="headerlink" href="#module-cpl.core.pipes.ip_address_pipe" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.ip_address_pipe.IPAddressPipe">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.ip_address_pipe.</span></span><span class="sig-name descname"><span class="pre">IPAddressPipe</span></span><a class="headerlink" href="#cpl_core.pipes.ip_address_pipe.IPAddressPipe" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.pipes.pipe_abc.PipeABC" title="cpl_core.pipes.pipe_abc.PipeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipeABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.ip_address_pipe.IPAddressPipe">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.pipes.ip_address_pipe.</span></span><span class="sig-name descname"><span class="pre">IPAddressPipe</span></span><a class="headerlink" href="#cpl.core.pipes.ip_address_pipe.IPAddressPipe" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.pipes.pipe_abc.PipeABC" title="cpl.core.pipes.pipe_abc.PipeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipeABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.ip_address_pipe.IPAddressPipe.transform">
|
||||
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.pipes.ip_address_pipe.IPAddressPipe.transform" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.ip_address_pipe.IPAddressPipe.transform">
|
||||
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.pipes.ip_address_pipe.IPAddressPipe.transform" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.pipes.pipe_abc">
|
||||
<span id="cpl-core-pipes-pipe-abc-module"></span><h2>cpl_core.pipes.pipe_abc module<a class="headerlink" href="#module-cpl_core.pipes.pipe_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.pipes.pipe_abc">
|
||||
<span id="cpl-core-pipes-pipe-abc-module"></span><h2>cpl.core.pipes.pipe_abc module<a class="headerlink" href="#module-cpl.core.pipes.pipe_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.pipe_abc.PipeABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.pipe_abc.</span></span><span class="sig-name descname"><span class="pre">PipeABC</span></span><a class="headerlink" href="#cpl_core.pipes.pipe_abc.PipeABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.pipe_abc.PipeABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.pipes.pipe_abc.</span></span><span class="sig-name descname"><span class="pre">PipeABC</span></span><a class="headerlink" href="#cpl.core.pipes.pipe_abc.PipeABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.pipe_abc.PipeABC.transform">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">any</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.pipes.pipe_abc.PipeABC.transform" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.pipe_abc.PipeABC.transform">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">any</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.pipes.pipe_abc.PipeABC.transform" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.pipes.to_camel_case_pipe">
|
||||
<span id="cpl-core-pipes-to-camel-case-pipe-module"></span><h2>cpl_core.pipes.to_camel_case_pipe module<a class="headerlink" href="#module-cpl_core.pipes.to_camel_case_pipe" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.pipes.to_camel_case_pipe">
|
||||
<span id="cpl-core-pipes-to-camel-case-pipe-module"></span><h2>cpl.core.pipes.to_camel_case_pipe module<a class="headerlink" href="#module-cpl.core.pipes.to_camel_case_pipe" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.to_camel_case_pipe.ToCamelCasePipe">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.to_camel_case_pipe.</span></span><span class="sig-name descname"><span class="pre">ToCamelCasePipe</span></span><a class="headerlink" href="#cpl_core.pipes.to_camel_case_pipe.ToCamelCasePipe" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.pipes.pipe_abc.PipeABC" title="cpl_core.pipes.pipe_abc.PipeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipeABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.to_camel_case_pipe.ToCamelCasePipe">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.pipes.to_camel_case_pipe.</span></span><span class="sig-name descname"><span class="pre">ToCamelCasePipe</span></span><a class="headerlink" href="#cpl.core.pipes.to_camel_case_pipe.ToCamelCasePipe" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.pipes.pipe_abc.PipeABC" title="cpl.core.pipes.pipe_abc.PipeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipeABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.to_camel_case_pipe.ToCamelCasePipe.transform">
|
||||
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl_core.pipes.to_camel_case_pipe.ToCamelCasePipe.transform" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.to_camel_case_pipe.ToCamelCasePipe.transform">
|
||||
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl.core.pipes.to_camel_case_pipe.ToCamelCasePipe.transform" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts string to camel case</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -251,15 +251,15 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.pipes.to_snake_case_pipe">
|
||||
<span id="cpl-core-pipes-to-snake-case-pipe-module"></span><h2>cpl_core.pipes.to_snake_case_pipe module<a class="headerlink" href="#module-cpl_core.pipes.to_snake_case_pipe" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.pipes.to_snake_case_pipe">
|
||||
<span id="cpl-core-pipes-to-snake-case-pipe-module"></span><h2>cpl.core.pipes.to_snake_case_pipe module<a class="headerlink" href="#module-cpl.core.pipes.to_snake_case_pipe" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.to_snake_case_pipe.ToSnakeCasePipe">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.to_snake_case_pipe.</span></span><span class="sig-name descname"><span class="pre">ToSnakeCasePipe</span></span><a class="headerlink" href="#cpl_core.pipes.to_snake_case_pipe.ToSnakeCasePipe" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.pipes.pipe_abc.PipeABC" title="cpl_core.pipes.pipe_abc.PipeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipeABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.to_snake_case_pipe.ToSnakeCasePipe">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.pipes.to_snake_case_pipe.</span></span><span class="sig-name descname"><span class="pre">ToSnakeCasePipe</span></span><a class="headerlink" href="#cpl.core.pipes.to_snake_case_pipe.ToSnakeCasePipe" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.pipes.pipe_abc.PipeABC" title="cpl.core.pipes.pipe_abc.PipeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipeABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.to_snake_case_pipe.ToSnakeCasePipe.transform">
|
||||
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl_core.pipes.to_snake_case_pipe.ToSnakeCasePipe.transform" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.to_snake_case_pipe.ToSnakeCasePipe.transform">
|
||||
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl.core.pipes.to_snake_case_pipe.ToSnakeCasePipe.transform" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts string to snake case</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -275,22 +275,22 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.pipes.version_pipe">
|
||||
<span id="cpl-core-pipes-version-pipe-module"></span><h2>cpl_core.pipes.version_pipe module<a class="headerlink" href="#module-cpl_core.pipes.version_pipe" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.pipes.version_pipe">
|
||||
<span id="cpl-core-pipes-version-pipe-module"></span><h2>cpl.core.pipes.version_pipe module<a class="headerlink" href="#module-cpl.core.pipes.version_pipe" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.version_pipe.VersionPipe">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.version_pipe.</span></span><span class="sig-name descname"><span class="pre">VersionPipe</span></span><a class="headerlink" href="#cpl_core.pipes.version_pipe.VersionPipe" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.pipes.pipe_abc.PipeABC" title="cpl_core.pipes.pipe_abc.PipeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipeABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.version_pipe.VersionPipe">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.pipes.version_pipe.</span></span><span class="sig-name descname"><span class="pre">VersionPipe</span></span><a class="headerlink" href="#cpl.core.pipes.version_pipe.VersionPipe" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.pipes.pipe_abc.PipeABC" title="cpl.core.pipes.pipe_abc.PipeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipeABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.version_pipe.VersionPipe.transform">
|
||||
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.pipes.version_pipe.VersionPipe.transform" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.version_pipe.VersionPipe.transform">
|
||||
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.pipes.version_pipe.VersionPipe.transform" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.pipes">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_core.pipes" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.pipes">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl.core.pipes" title="Permalink to this heading"></a></h2>
|
||||
<section id="cpl-core-cpl-core">
|
||||
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL core package</p>
|
||||
@@ -306,24 +306,24 @@
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.pipes.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.pipes.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.pipes.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_core.pipes.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl.core.pipes.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_core.pipes.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl.core.pipes.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.pipes.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_core.pipes.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.pipes.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl.core.pipes.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
@@ -336,8 +336,8 @@
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_mail.html" class="btn btn-neutral float-left" title="cpl_mail package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_core.time.html" class="btn btn-neutral float-right" title="cpl_core.time package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.mail.html" class="btn btn-neutral float-left" title="cpl.mail package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl.core.time.html" class="btn btn-neutral float-right" title="cpl.core.time package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
126
docs/build/html/cpl_core.time.html
vendored
126
docs/build/html/cpl_core.time.html
vendored
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_core.time package — Common Python Library documentation</title>
|
||||
<title>cpl.core.time package — Common Python Library documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -19,8 +19,8 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="cpl_core.utils package" href="cpl_core.utils.html" />
|
||||
<link rel="prev" title="cpl_core.pipes package" href="cpl_core.pipes.html" />
|
||||
<link rel="next" title="cpl.core.utils package" href="cpl.core.utils.html" />
|
||||
<link rel="prev" title="cpl.core.pipes package" href="cpl.core.pipes.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -48,38 +48,38 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html">cpl_core.database package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.log.html">cpl_core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_mail.html">cpl_mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.time package</a><ul>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl.core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.application.html">cpl.core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.configuration.html">cpl.core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.console.html">cpl.core.console package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.database.html">cpl.core.database package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.dependency_injection.html">cpl.core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.environment.html">cpl.core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.log.html">cpl.core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mail.html">cpl.mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.pipes.html">cpl.core.pipes package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.core.time package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.time.time_format_settings">cpl_core.time.time_format_settings module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.time.time_format_settings.TimeFormatSettings"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettings</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.time.time_format_settings">cpl.core.time.time_format_settings module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.time.time_format_settings.TimeFormatSettings"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettings</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.time.time_format_settings_names_enum">cpl_core.time.time_format_settings_names_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettingsNamesEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.time.time_format_settings_names_enum">cpl.core.time.time_format_settings_names_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettingsNamesEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.time">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.time">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.time.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.time.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.utils.html">cpl.core.utils package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -97,10 +97,10 @@
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl_core.time package</li>
|
||||
<li class="breadcrumb-item"><a href="cpl.core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl.core.time package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_core.time.rst.txt" rel="nofollow"> View page source</a>
|
||||
<a href="_sources/cpl.core.time.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -109,72 +109,72 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="cpl-core-time-package">
|
||||
<h1>cpl_core.time package<a class="headerlink" href="#cpl-core-time-package" title="Permalink to this heading"></a></h1>
|
||||
<h1>cpl.core.time package<a class="headerlink" href="#cpl-core-time-package" title="Permalink to this heading"></a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_core.time.time_format_settings">
|
||||
<span id="cpl-core-time-time-format-settings-module"></span><h2>cpl_core.time.time_format_settings module<a class="headerlink" href="#module-cpl_core.time.time_format_settings" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.time.time_format_settings">
|
||||
<span id="cpl-core-time-time-format-settings-module"></span><h2>cpl.core.time.time_format_settings module<a class="headerlink" href="#module-cpl.core.time.time_format_settings" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.time.time_format_settings.TimeFormatSettings">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.time.time_format_settings.</span></span><span class="sig-name descname"><span class="pre">TimeFormatSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">time_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">date_time_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">date_time_log_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.time.time_format_settings.TimeFormatSettings" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.time.time_format_settings.TimeFormatSettings">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.time.time_format_settings.</span></span><span class="sig-name descname"><span class="pre">TimeFormatSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">time_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">date_time_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">date_time_log_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.time.time_format_settings.TimeFormatSettings" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
|
||||
<p>Representation of time format settings</p>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.time.time_format_settings.TimeFormatSettings.date_format">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date_format</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.time.time_format_settings.TimeFormatSettings.date_format" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.time.time_format_settings.TimeFormatSettings.date_format">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date_format</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.time.time_format_settings.TimeFormatSettings.date_format" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.time.time_format_settings.TimeFormatSettings.date_time_format">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date_time_format</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.time.time_format_settings.TimeFormatSettings.date_time_format" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.time.time_format_settings.TimeFormatSettings.date_time_format">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date_time_format</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.time.time_format_settings.TimeFormatSettings.date_time_format" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.time.time_format_settings.TimeFormatSettings.date_time_log_format">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date_time_log_format</span></span><a class="headerlink" href="#cpl_core.time.time_format_settings.TimeFormatSettings.date_time_log_format" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.time.time_format_settings.TimeFormatSettings.date_time_log_format">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date_time_log_format</span></span><a class="headerlink" href="#cpl.core.time.time_format_settings.TimeFormatSettings.date_time_log_format" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.time.time_format_settings.TimeFormatSettings.time_format">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">time_format</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.time.time_format_settings.TimeFormatSettings.time_format" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.time.time_format_settings.TimeFormatSettings.time_format">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">time_format</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl.core.time.time_format_settings.TimeFormatSettings.time_format" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.time.time_format_settings_names_enum">
|
||||
<span id="cpl-core-time-time-format-settings-names-enum-module"></span><h2>cpl_core.time.time_format_settings_names_enum module<a class="headerlink" href="#module-cpl_core.time.time_format_settings_names_enum" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.time.time_format_settings_names_enum">
|
||||
<span id="cpl-core-time-time-format-settings-names-enum-module"></span><h2>cpl.core.time.time_format_settings_names_enum module<a class="headerlink" href="#module-cpl.core.time.time_format_settings_names_enum" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.time.time_format_settings_names_enum.</span></span><span class="sig-name descname"><span class="pre">TimeFormatSettingsNamesEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.time.time_format_settings_names_enum.</span></span><span class="sig-name descname"><span class="pre">TimeFormatSettingsNamesEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
||||
<p>An enumeration.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.date_format">
|
||||
<span class="sig-name descname"><span class="pre">date_format</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DateFormat'</span></em><a class="headerlink" href="#cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.date_format" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.date_format">
|
||||
<span class="sig-name descname"><span class="pre">date_format</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DateFormat'</span></em><a class="headerlink" href="#cpl.core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.date_format" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.date_time_format">
|
||||
<span class="sig-name descname"><span class="pre">date_time_format</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DateTimeFormat'</span></em><a class="headerlink" href="#cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.date_time_format" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.date_time_format">
|
||||
<span class="sig-name descname"><span class="pre">date_time_format</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DateTimeFormat'</span></em><a class="headerlink" href="#cpl.core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.date_time_format" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.date_time_log_format">
|
||||
<span class="sig-name descname"><span class="pre">date_time_log_format</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DateTimeLogFormat'</span></em><a class="headerlink" href="#cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.date_time_log_format" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.date_time_log_format">
|
||||
<span class="sig-name descname"><span class="pre">date_time_log_format</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DateTimeLogFormat'</span></em><a class="headerlink" href="#cpl.core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.date_time_log_format" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.time_format">
|
||||
<span class="sig-name descname"><span class="pre">time_format</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TimeFormat'</span></em><a class="headerlink" href="#cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.time_format" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.time_format">
|
||||
<span class="sig-name descname"><span class="pre">time_format</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TimeFormat'</span></em><a class="headerlink" href="#cpl.core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.time_format" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.time">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_core.time" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.time">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl.core.time" title="Permalink to this heading"></a></h2>
|
||||
<section id="cpl-core-cpl-core">
|
||||
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL core package</p>
|
||||
@@ -190,24 +190,24 @@
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.time.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.time.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.time.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.time.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.time.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.time.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.time.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_core.time.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.time.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl.core.time.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.time.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_core.time.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.time.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl.core.time.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.time.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_core.time.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.time.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl.core.time.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
@@ -220,8 +220,8 @@
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_core.pipes.html" class="btn btn-neutral float-left" title="cpl_core.pipes package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_core.utils.html" class="btn btn-neutral float-right" title="cpl_core.utils package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.core.pipes.html" class="btn btn-neutral float-left" title="cpl.core.pipes package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl.core.utils.html" class="btn btn-neutral float-right" title="cpl.core.utils package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
160
docs/build/html/cpl_core.utils.html
vendored
160
docs/build/html/cpl_core.utils.html
vendored
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_core.utils package — Common Python Library documentation</title>
|
||||
<title>cpl.core.utils package — Common Python Library documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -20,7 +20,7 @@
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Discord Reference" href="cpl_discord.html" />
|
||||
<link rel="prev" title="cpl_core.time package" href="cpl_core.time.html" />
|
||||
<link rel="prev" title="cpl.core.time package" href="cpl.core.time.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -48,34 +48,34 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html">cpl_core.database package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.log.html">cpl_core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_mail.html">cpl_mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.utils package</a><ul>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl.core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.application.html">cpl.core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.configuration.html">cpl.core.configuration package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.console.html">cpl.core.console package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.database.html">cpl.core.database package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.dependency_injection.html">cpl.core.dependency_injection package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.environment.html">cpl.core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.log.html">cpl.core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mail.html">cpl.mail package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.pipes.html">cpl.core.pipes package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.time.html">cpl.core.time package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.core.utils package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.utils.credential_manager">cpl_core.utils.credential_manager module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.utils.credential_manager.CredentialManager"><code class="docutils literal notranslate"><span class="pre">CredentialManager</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.utils.credential_manager">cpl.core.utils.credential_manager module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.utils.credential_manager.CredentialManager"><code class="docutils literal notranslate"><span class="pre">CredentialManager</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.utils.pip">cpl_core.utils.pip module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.utils.pip.Pip"><code class="docutils literal notranslate"><span class="pre">Pip</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.utils.pip">cpl.core.utils.pip module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.utils.pip.Pip"><code class="docutils literal notranslate"><span class="pre">Pip</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.utils.string">cpl_core.utils.string module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.utils.string.String"><code class="docutils literal notranslate"><span class="pre">String</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.utils.string">cpl.core.utils.string module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.utils.string.String"><code class="docutils literal notranslate"><span class="pre">String</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.utils">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.utils">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.utils.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.utils.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -83,7 +83,7 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -101,10 +101,10 @@
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl_core.utils package</li>
|
||||
<li class="breadcrumb-item"><a href="cpl.core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl.core.utils package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_core.utils.rst.txt" rel="nofollow"> View page source</a>
|
||||
<a href="_sources/cpl.core.utils.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -113,20 +113,20 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="cpl-core-utils-package">
|
||||
<h1>cpl_core.utils package<a class="headerlink" href="#cpl-core-utils-package" title="Permalink to this heading"></a></h1>
|
||||
<h1>cpl.core.utils package<a class="headerlink" href="#cpl-core-utils-package" title="Permalink to this heading"></a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_core.utils.credential_manager">
|
||||
<span id="cpl-core-utils-credential-manager-module"></span><h2>cpl_core.utils.credential_manager module<a class="headerlink" href="#module-cpl_core.utils.credential_manager" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.utils.credential_manager">
|
||||
<span id="cpl-core-utils-credential-manager-module"></span><h2>cpl.core.utils.credential_manager module<a class="headerlink" href="#module-cpl.core.utils.credential_manager" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.credential_manager.CredentialManager">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.utils.credential_manager.</span></span><span class="sig-name descname"><span class="pre">CredentialManager</span></span><a class="headerlink" href="#cpl_core.utils.credential_manager.CredentialManager" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.credential_manager.CredentialManager">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.utils.credential_manager.</span></span><span class="sig-name descname"><span class="pre">CredentialManager</span></span><a class="headerlink" href="#cpl.core.utils.credential_manager.CredentialManager" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>Handles credential encryption and decryption</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.credential_manager.CredentialManager.build_string">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.utils.credential_manager.CredentialManager.build_string" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.credential_manager.CredentialManager.build_string">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.utils.credential_manager.CredentialManager.build_string" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Builds string with credentials in it</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -142,8 +142,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.credential_manager.CredentialManager.decrypt">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">decrypt</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl_core.utils.credential_manager.CredentialManager.decrypt" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.credential_manager.CredentialManager.decrypt">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">decrypt</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl.core.utils.credential_manager.CredentialManager.decrypt" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Decode with base64</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -157,8 +157,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.credential_manager.CredentialManager.encrypt">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">encrypt</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl_core.utils.credential_manager.CredentialManager.encrypt" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.credential_manager.CredentialManager.encrypt">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">encrypt</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl.core.utils.credential_manager.CredentialManager.encrypt" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Encode with base64</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -174,21 +174,21 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.utils.pip">
|
||||
<span id="cpl-core-utils-pip-module"></span><h2>cpl_core.utils.pip module<a class="headerlink" href="#module-cpl_core.utils.pip" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.utils.pip">
|
||||
<span id="cpl-core-utils-pip-module"></span><h2>cpl.core.utils.pip module<a class="headerlink" href="#module-cpl.core.utils.pip" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.pip.Pip">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.utils.pip.</span></span><span class="sig-name descname"><span class="pre">Pip</span></span><a class="headerlink" href="#cpl_core.utils.pip.Pip" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.pip.Pip">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.utils.pip.</span></span><span class="sig-name descname"><span class="pre">Pip</span></span><a class="headerlink" href="#cpl.core.utils.pip.Pip" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>Executes pip commands</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.pip.Pip.get_executable">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_executable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl_core.utils.pip.Pip.get_executable" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.pip.Pip.get_executable">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_executable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl.core.utils.pip.Pip.get_executable" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.pip.Pip.get_outdated">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_outdated</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#cpl_core.utils.pip.Pip.get_outdated" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.pip.Pip.get_outdated">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_outdated</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="headerlink" href="#cpl.core.utils.pip.Pip.get_outdated" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Gets table of outdated packages</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Bytes string of the command result</p>
|
||||
@@ -197,8 +197,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.pip.Pip.get_package">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_package</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_core.utils.pip.Pip.get_package" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.pip.Pip.get_package">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_package</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl.core.utils.pip.Pip.get_package" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Gets given package py local pip list</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><p>package: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||||
@@ -209,8 +209,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.pip.Pip.install">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">install</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stdout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stderr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.utils.pip.Pip.install" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.pip.Pip.install">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">install</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stdout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stderr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.utils.pip.Pip.install" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Installs given package</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -230,14 +230,14 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.pip.Pip.reset_executable">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">reset_executable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.utils.pip.Pip.reset_executable" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.pip.Pip.reset_executable">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">reset_executable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.utils.pip.Pip.reset_executable" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Resets the executable to system standard</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.pip.Pip.set_executable">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_executable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.utils.pip.Pip.set_executable" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.pip.Pip.set_executable">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_executable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.utils.pip.Pip.set_executable" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets the executable</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -249,8 +249,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.pip.Pip.uninstall">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uninstall</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stdout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stderr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.utils.pip.Pip.uninstall" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.pip.Pip.uninstall">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uninstall</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stdout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stderr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.utils.pip.Pip.uninstall" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Uninstalls given package</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -268,16 +268,16 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.utils.string">
|
||||
<span id="cpl-core-utils-string-module"></span><h2>cpl_core.utils.string module<a class="headerlink" href="#module-cpl_core.utils.string" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.utils.string">
|
||||
<span id="cpl-core-utils-string-module"></span><h2>cpl.core.utils.string module<a class="headerlink" href="#module-cpl.core.utils.string" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.string.String">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.utils.string.</span></span><span class="sig-name descname"><span class="pre">String</span></span><a class="headerlink" href="#cpl_core.utils.string.String" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.string.String">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.utils.string.</span></span><span class="sig-name descname"><span class="pre">String</span></span><a class="headerlink" href="#cpl.core.utils.string.String" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>Useful functions for strings</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.string.String.convert_to_camel_case">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">convert_to_camel_case</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl_core.utils.string.String.convert_to_camel_case" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.string.String.convert_to_camel_case">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">convert_to_camel_case</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl.core.utils.string.String.convert_to_camel_case" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts string to camel case</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -291,8 +291,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.string.String.convert_to_snake_case">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">convert_to_snake_case</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl_core.utils.string.String.convert_to_snake_case" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.string.String.convert_to_snake_case">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">convert_to_snake_case</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl.core.utils.string.String.convert_to_snake_case" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts string to snake case</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -306,8 +306,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.string.String.first_to_lower">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">first_to_lower</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl_core.utils.string.String.first_to_lower" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.string.String.first_to_lower">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">first_to_lower</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl.core.utils.string.String.first_to_lower" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts first char to lower</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -321,8 +321,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.string.String.first_to_upper">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">first_to_upper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl_core.utils.string.String.first_to_upper" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.string.String.first_to_upper">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">first_to_upper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl.core.utils.string.String.first_to_upper" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts first char to upper</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -336,8 +336,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.string.String.random_string">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">random_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">length</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl_core.utils.string.String.random_string" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.string.String.random_string">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">random_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">length</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl.core.utils.string.String.random_string" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates random string by given chars and length</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>String of random chars</p>
|
||||
@@ -348,8 +348,8 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.utils">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_core.utils" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.utils">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl.core.utils" title="Permalink to this heading"></a></h2>
|
||||
<section id="cpl-core-cpl-core">
|
||||
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL core package</p>
|
||||
@@ -365,24 +365,24 @@
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.utils.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.utils.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.utils.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.utils.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_core.utils.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl.core.utils.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_core.utils.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl.core.utils.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.utils.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_core.utils.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.utils.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl.core.utils.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
@@ -395,7 +395,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_core.time.html" class="btn btn-neutral float-left" title="cpl_core.time package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl.core.time.html" class="btn btn-neutral float-left" title="cpl.core.time package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_discord.html" class="btn btn-neutral float-right" title="Discord Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
|
||||
8
docs/build/html/cpl_discord.application.html
vendored
8
docs/build/html/cpl_discord.application.html
vendored
@@ -48,7 +48,7 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord Reference</a><ul class="current">
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_discord.application package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
@@ -72,7 +72,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.html#module-cpl_discord.discord_event_types_enum">cpl_discord.discord_event_types_enum module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -110,8 +110,8 @@
|
||||
<span id="cpl-discord-application-discord-bot-application-abc-module"></span><h2>cpl_discord.application.discord_bot_application_abc module<a class="headerlink" href="#module-cpl_discord.application.discord_bot_application_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_discord.application.discord_bot_application_abc.DiscordBotApplicationABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.application.discord_bot_application_abc.</span></span><span class="sig-name descname"><span class="pre">DiscordBotApplicationABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.application.discord_bot_application_abc.DiscordBotApplicationABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplicationABC</span></code></a></p>
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.application.discord_bot_application_abc.</span></span><span class="sig-name descname"><span class="pre">DiscordBotApplicationABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_abc.ConfigurationABC" title="cpl.core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.application.discord_bot_application_abc.DiscordBotApplicationABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.core.application.html#cpl.core.application.application_abc.ApplicationABC" title="cpl.core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplicationABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_discord.application.discord_bot_application_abc.DiscordBotApplicationABC.stop_async">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">stop_async</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.application.discord_bot_application_abc.DiscordBotApplicationABC.stop_async" title="Permalink to this definition"></a></dt>
|
||||
|
||||
4
docs/build/html/cpl_discord.command.html
vendored
4
docs/build/html/cpl_discord.command.html
vendored
@@ -48,7 +48,7 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord Reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_discord.command package</a><ul>
|
||||
@@ -76,7 +76,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.html#module-cpl_discord.discord_event_types_enum">cpl_discord.discord_event_types_enum module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@@ -48,7 +48,7 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord Reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html">cpl_discord.command package</a></li>
|
||||
@@ -72,7 +72,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.html#module-cpl_discord.discord_event_types_enum">cpl_discord.discord_event_types_enum module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -111,7 +111,7 @@
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_discord.configuration.discord_bot_settings.DiscordBotSettings">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.configuration.discord_bot_settings.</span></span><span class="sig-name descname"><span class="pre">DiscordBotSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.configuration.discord_bot_settings.DiscordBotSettings" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_discord.configuration.discord_bot_settings.DiscordBotSettings.prefix">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">prefix</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_discord.configuration.discord_bot_settings.DiscordBotSettings.prefix" title="Permalink to this definition"></a></dt>
|
||||
|
||||
4
docs/build/html/cpl_discord.container.html
vendored
4
docs/build/html/cpl_discord.container.html
vendored
@@ -48,7 +48,7 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord Reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html">cpl_discord.command package</a></li>
|
||||
@@ -100,7 +100,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.html#module-cpl_discord.discord_event_types_enum">cpl_discord.discord_event_types_enum module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
4
docs/build/html/cpl_discord.events.html
vendored
4
docs/build/html/cpl_discord.events.html
vendored
@@ -48,7 +48,7 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord Reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html">cpl_discord.command package</a></li>
|
||||
@@ -272,7 +272,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.html#module-cpl_discord.discord_event_types_enum">cpl_discord.discord_event_types_enum module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
4
docs/build/html/cpl_discord.helper.html
vendored
4
docs/build/html/cpl_discord.helper.html
vendored
@@ -48,7 +48,7 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord Reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html">cpl_discord.command package</a></li>
|
||||
@@ -72,7 +72,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.html#module-cpl_discord.discord_event_types_enum">cpl_discord.discord_event_types_enum module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
8
docs/build/html/cpl_discord.html
vendored
8
docs/build/html/cpl_discord.html
vendored
@@ -20,7 +20,7 @@
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="cpl_discord.application package" href="cpl_discord.application.html" />
|
||||
<link rel="prev" title="cpl_core.utils package" href="cpl_core.utils.html" />
|
||||
<link rel="prev" title="cpl.core.utils package" href="cpl.core.utils.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -48,7 +48,7 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Discord Reference</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html">cpl_discord.command package</a></li>
|
||||
@@ -121,7 +121,7 @@
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -1234,7 +1234,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_core.utils.html" class="btn btn-neutral float-left" title="cpl_core.utils package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl.core.utils.html" class="btn btn-neutral float-left" title="cpl.core.utils package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_discord.application.html" class="btn btn-neutral float-right" title="cpl_discord.application package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
|
||||
16
docs/build/html/cpl_discord.service.html
vendored
16
docs/build/html/cpl_discord.service.html
vendored
@@ -19,7 +19,7 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Query reference" href="cpl_query.html" />
|
||||
<link rel="next" title="Query reference" href="cpl.query.html" />
|
||||
<link rel="prev" title="cpl_discord.helper package" href="cpl_discord.helper.html" />
|
||||
</head>
|
||||
|
||||
@@ -48,7 +48,7 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord Reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html">cpl_discord.command package</a></li>
|
||||
@@ -96,7 +96,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.html#module-cpl_discord.discord_event_types_enum">cpl_discord.discord_event_types_enum module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -134,7 +134,7 @@
|
||||
<span id="cpl-discord-service-command-error-handler-service-module"></span><h2>cpl_discord.service.command_error_handler_service module<a class="headerlink" href="#module-cpl_discord.service.command_error_handler_service" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_discord.service.command_error_handler_service.CommandErrorHandlerService">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.service.command_error_handler_service.</span></span><span class="sig-name descname"><span class="pre">CommandErrorHandlerService</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.log.html#cpl_core.log.logger_abc.LoggerABC" title="cpl_core.log.logger_abc.LoggerABC"><span class="pre">LoggerABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.command_error_handler_service.CommandErrorHandlerService" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.service.command_error_handler_service.</span></span><span class="sig-name descname"><span class="pre">CommandErrorHandlerService</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.log.html#cpl.core.log.logger_abc.LoggerABC" title="cpl.core.log.logger_abc.LoggerABC"><span class="pre">LoggerABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.command_error_handler_service.CommandErrorHandlerService" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_discord.events.html#cpl_discord.events.on_command_error_abc.OnCommandErrorABC" title="cpl_discord.events.on_command_error_abc.OnCommandErrorABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">OnCommandErrorABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_discord.service.command_error_handler_service.CommandErrorHandlerService.on_command_error">
|
||||
@@ -148,7 +148,7 @@
|
||||
<span id="cpl-discord-service-discord-bot-service-module"></span><h2>cpl_discord.service.discord_bot_service module<a class="headerlink" href="#module-cpl_discord.service.discord_bot_service" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_discord.service.discord_bot_service.DiscordBotService">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.service.discord_bot_service.</span></span><span class="sig-name descname"><span class="pre">DiscordBotService</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.log.html#cpl_core.log.logger_abc.LoggerABC" title="cpl_core.log.logger_abc.LoggerABC"><span class="pre">LoggerABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">discord_bot_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_discord.configuration.html#cpl_discord.configuration.discord_bot_settings.DiscordBotSettings" title="cpl_discord.configuration.discord_bot_settings.DiscordBotSettings"><span class="pre">DiscordBotSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">logging_st</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.log.html#cpl_core.log.logging_settings.LoggingSettings" title="cpl_core.log.logging_settings.LoggingSettings"><span class="pre">LoggingSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">discord_service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC" title="cpl_discord.service.discord_service_abc.DiscordServiceABC"><span class="pre">DiscordServiceABC</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_bot_service.DiscordBotService" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.service.discord_bot_service.</span></span><span class="sig-name descname"><span class="pre">DiscordBotService</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_abc.ConfigurationABC" title="cpl.core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.log.html#cpl.core.log.logger_abc.LoggerABC" title="cpl.core.log.logger_abc.LoggerABC"><span class="pre">LoggerABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">discord_bot_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_discord.configuration.html#cpl_discord.configuration.discord_bot_settings.DiscordBotSettings" title="cpl_discord.configuration.discord_bot_settings.DiscordBotSettings"><span class="pre">DiscordBotSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.environment.html#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">logging_st</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.log.html#cpl.core.log.logging_settings.LoggingSettings" title="cpl.core.log.logging_settings.LoggingSettings"><span class="pre">LoggingSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">discord_service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC" title="cpl_discord.service.discord_service_abc.DiscordServiceABC"><span class="pre">DiscordServiceABC</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_bot_service.DiscordBotService" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC" title="cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">DiscordBotServiceABC</span></code></a></p>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_discord.service.discord_bot_service.DiscordBotService.guilds">
|
||||
@@ -208,7 +208,7 @@
|
||||
<span id="cpl-discord-service-discord-collection-module"></span><h2>cpl_discord.service.discord_collection module<a class="headerlink" href="#module-cpl_discord.service.discord_collection" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_discord.service.discord_collection.DiscordCollection">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.service.discord_collection.</span></span><span class="sig-name descname"><span class="pre">DiscordCollection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_collection</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_collection.DiscordCollection" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.service.discord_collection.</span></span><span class="sig-name descname"><span class="pre">DiscordCollection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_collection</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_collection.DiscordCollection" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_discord.service.discord_collection_abc.DiscordCollectionABC" title="cpl_discord.service.discord_collection_abc.DiscordCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">DiscordCollectionABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_discord.service.discord_collection.DiscordCollection.add_command">
|
||||
@@ -227,7 +227,7 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_discord.service.discord_collection.DiscordCollection.get_events_by_base">
|
||||
<span class="sig-name descname"><span class="pre">get_events_by_base</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t_event</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.list.List" title="cpl_query.extension.list.List"><span class="pre">List</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_discord.service.discord_collection.DiscordCollection.get_events_by_base" title="Permalink to this definition"></a></dt>
|
||||
<span class="sig-name descname"><span class="pre">get_events_by_base</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t_event</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl.query.extension.html#cpl.query.extension.list.List" title="cpl.query.extension.list.List"><span class="pre">List</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_discord.service.discord_collection.DiscordCollection.get_events_by_base" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@@ -853,7 +853,7 @@
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_discord.helper.html" class="btn btn-neutral float-left" title="cpl_discord.helper package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_query.html" class="btn btn-neutral float-right" title="Query reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.query.html" class="btn btn-neutral float-right" title="Query reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
320
docs/build/html/cpl_query.base.html
vendored
320
docs/build/html/cpl_query.base.html
vendored
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_query.base package — Common Python Library documentation</title>
|
||||
<title>cpl.query.base package — Common Python Library documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -19,8 +19,8 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="cpl_query.enumerable package" href="cpl_query.enumerable.html" />
|
||||
<link rel="prev" title="Query reference" href="cpl_query.html" />
|
||||
<link rel="next" title="cpl.query.enumerable package" href="cpl.query.enumerable.html" />
|
||||
<link rel="prev" title="Query reference" href="cpl.query.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -48,41 +48,41 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_query.html">Query reference</a><ul class="current">
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_query.base package</a><ul>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl.query.html">Query reference</a><ul class="current">
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.query.base package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.default_lambda">cpl_query.base.default_lambda module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.base.default_lambda.default_lambda"><code class="docutils literal notranslate"><span class="pre">default_lambda()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.query.base.default_lambda">cpl.query.base.default_lambda module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.query.base.default_lambda.default_lambda"><code class="docutils literal notranslate"><span class="pre">default_lambda()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.ordered_queryable">cpl_query.base.ordered_queryable module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.base.ordered_queryable.OrderedQueryable"><code class="docutils literal notranslate"><span class="pre">OrderedQueryable</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.query.base.ordered_queryable">cpl.query.base.ordered_queryable module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.query.base.ordered_queryable.OrderedQueryable"><code class="docutils literal notranslate"><span class="pre">OrderedQueryable</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.ordered_queryable_abc">cpl_query.base.ordered_queryable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="docutils literal notranslate"><span class="pre">OrderedQueryableABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.query.base.ordered_queryable_abc">cpl.query.base.ordered_queryable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="docutils literal notranslate"><span class="pre">OrderedQueryableABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.queryable_abc">cpl_query.base.queryable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC"><code class="docutils literal notranslate"><span class="pre">QueryableABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.query.base.queryable_abc">cpl.query.base.queryable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.query.base.queryable_abc.QueryableABC"><code class="docutils literal notranslate"><span class="pre">QueryableABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.sequence">cpl_query.base.sequence module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.base.sequence.Sequence"><code class="docutils literal notranslate"><span class="pre">Sequence</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.query.base.sequence">cpl.query.base.sequence module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.query.base.sequence.Sequence"><code class="docutils literal notranslate"><span class="pre">Sequence</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.query.base">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.base.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.query.base.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html">cpl_query.enumerable package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.extension.html">cpl_query.extension package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.iterable.html">cpl_query.iterable package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.enumerable.html">cpl.query.enumerable package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.extension.html">cpl.query.extension package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.iterable.html">cpl.query.iterable package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
@@ -102,10 +102,10 @@
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_query.html">Query reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl_query.base package</li>
|
||||
<li class="breadcrumb-item"><a href="cpl.query.html">Query reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl.query.base package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_query.base.rst.txt" rel="nofollow"> View page source</a>
|
||||
<a href="_sources/cpl.query.base.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -114,45 +114,45 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="cpl-query-base-package">
|
||||
<h1>cpl_query.base package<a class="headerlink" href="#cpl-query-base-package" title="Permalink to this heading"></a></h1>
|
||||
<h1>cpl.query.base package<a class="headerlink" href="#cpl-query-base-package" title="Permalink to this heading"></a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_query.base.default_lambda">
|
||||
<span id="cpl-query-base-default-lambda-module"></span><h2>cpl_query.base.default_lambda module<a class="headerlink" href="#module-cpl_query.base.default_lambda" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.query.base.default_lambda">
|
||||
<span id="cpl-query-base-default-lambda-module"></span><h2>cpl.query.base.default_lambda module<a class="headerlink" href="#module-cpl.query.base.default_lambda" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.default_lambda.default_lambda">
|
||||
<span class="sig-prename descclassname"><span class="pre">cpl_query.base.default_lambda.</span></span><span class="sig-name descname"><span class="pre">default_lambda</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.default_lambda.default_lambda" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.default_lambda.default_lambda">
|
||||
<span class="sig-prename descclassname"><span class="pre">cpl.query.base.default_lambda.</span></span><span class="sig-name descname"><span class="pre">default_lambda</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.query.base.default_lambda.default_lambda" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_query.base.ordered_queryable">
|
||||
<span id="cpl-query-base-ordered-queryable-module"></span><h2>cpl_query.base.ordered_queryable module<a class="headerlink" href="#module-cpl_query.base.ordered_queryable" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.query.base.ordered_queryable">
|
||||
<span id="cpl-query-base-ordered-queryable-module"></span><h2>cpl.query.base.ordered_queryable module<a class="headerlink" href="#module-cpl.query.base.ordered_queryable" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable.OrderedQueryable">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.ordered_queryable.</span></span><span class="sig-name descname"><span class="pre">OrderedQueryable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable.Iterable" title="cpl_query.iterable.iterable.Iterable"><span class="pre">Iterable</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.ordered_queryable.OrderedQueryable" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">OrderedQueryableABC</span></code></a></p>
|
||||
<p>Implementation of :class: <cite>cpl_query.base.ordered_queryable_abc.OrderedQueryableABC</cite></p>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.ordered_queryable.OrderedQueryable">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.query.base.ordered_queryable.</span></span><span class="sig-name descname"><span class="pre">OrderedQueryable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.query.iterable.html#cpl.query.iterable.iterable.Iterable" title="cpl.query.iterable.iterable.Iterable"><span class="pre">Iterable</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.query.base.ordered_queryable.OrderedQueryable" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl.query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">OrderedQueryableABC</span></code></a></p>
|
||||
<p>Implementation of :class: <cite>cpl.query.base.ordered_queryable_abc.OrderedQueryableABC</cite></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable.OrderedQueryable.then_by">
|
||||
<span class="sig-name descname"><span class="pre">then_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.ordered_queryable.OrderedQueryable.then_by" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.ordered_queryable.OrderedQueryable.then_by">
|
||||
<span class="sig-name descname"><span class="pre">then_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl.query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl.query.base.ordered_queryable.OrderedQueryable.then_by" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sorts OrderedList in ascending order by function</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>list of <a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.base.ordered_queryable_abc.OrderedQueryableABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>list of <a class="reference internal" href="#cpl.query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl.query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.query.base.ordered_queryable_abc.OrderedQueryableABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable.OrderedQueryable.then_by_descending">
|
||||
<span class="sig-name descname"><span class="pre">then_by_descending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.ordered_queryable.OrderedQueryable.then_by_descending" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.ordered_queryable.OrderedQueryable.then_by_descending">
|
||||
<span class="sig-name descname"><span class="pre">then_by_descending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl.query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl.query.base.ordered_queryable.OrderedQueryable.then_by_descending" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sorts OrderedList in descending order by function</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>list of <a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.base.ordered_queryable_abc.OrderedQueryableABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>list of <a class="reference internal" href="#cpl.query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl.query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.query.base.ordered_queryable_abc.OrderedQueryableABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -160,32 +160,32 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_query.base.ordered_queryable_abc">
|
||||
<span id="cpl-query-base-ordered-queryable-abc-module"></span><h2>cpl_query.base.ordered_queryable_abc module<a class="headerlink" href="#module-cpl_query.base.ordered_queryable_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.query.base.ordered_queryable_abc">
|
||||
<span id="cpl-query-base-ordered-queryable-abc-module"></span><h2>cpl.query.base.ordered_queryable_abc module<a class="headerlink" href="#module-cpl.query.base.ordered_queryable_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.ordered_queryable_abc.</span></span><span class="sig-name descname"><span class="pre">OrderedQueryableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryableABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.ordered_queryable_abc.OrderedQueryableABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.query.base.ordered_queryable_abc.</span></span><span class="sig-name descname"><span class="pre">OrderedQueryableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.query.base.ordered_queryable_abc.OrderedQueryableABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.query.base.queryable_abc.QueryableABC" title="cpl.query.base.queryable_abc.QueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryableABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC.then_by">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">then_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC.then_by" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.ordered_queryable_abc.OrderedQueryableABC.then_by">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">then_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl.query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl.query.base.ordered_queryable_abc.OrderedQueryableABC.then_by" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sorts OrderedList in ascending order by function</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>list of <a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.base.ordered_queryable_abc.OrderedQueryableABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>list of <a class="reference internal" href="#cpl.query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl.query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.query.base.ordered_queryable_abc.OrderedQueryableABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC.then_by_descending">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">then_by_descending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC.then_by_descending" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.ordered_queryable_abc.OrderedQueryableABC.then_by_descending">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">then_by_descending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl.query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl.query.base.ordered_queryable_abc.OrderedQueryableABC.then_by_descending" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sorts OrderedList in descending order by function</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>list of <a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.base.ordered_queryable_abc.OrderedQueryableABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>list of <a class="reference internal" href="#cpl.query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl.query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.query.base.ordered_queryable_abc.OrderedQueryableABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -193,15 +193,15 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_query.base.queryable_abc">
|
||||
<span id="cpl-query-base-queryable-abc-module"></span><h2>cpl_query.base.queryable_abc module<a class="headerlink" href="#module-cpl_query.base.queryable_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.query.base.queryable_abc">
|
||||
<span id="cpl-query-base-queryable-abc-module"></span><h2>cpl.query.base.queryable_abc module<a class="headerlink" href="#module-cpl.query.base.queryable_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.queryable_abc.</span></span><span class="sig-name descname"><span class="pre">QueryableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_query.base.sequence.Sequence" title="cpl_query.base.sequence.Sequence"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.query.base.queryable_abc.</span></span><span class="sig-name descname"><span class="pre">QueryableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.query.base.sequence.Sequence" title="cpl.query.base.sequence.Sequence"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.all">
|
||||
<span class="sig-name descname"><span class="pre">all</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.all" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.all">
|
||||
<span class="sig-name descname"><span class="pre">all</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.all" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Checks if every element of list equals result found by function</p>
|
||||
<section id="parameter">
|
||||
<h3>Parameter<a class="headerlink" href="#parameter" title="Permalink to this heading"></a></h3>
|
||||
@@ -221,8 +221,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.any">
|
||||
<span class="sig-name descname"><span class="pre">any</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.any" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.any">
|
||||
<span class="sig-name descname"><span class="pre">any</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.any" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Checks if list contains result found by function</p>
|
||||
<section id="id1">
|
||||
<h3>Parameter<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h3>
|
||||
@@ -242,8 +242,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.average">
|
||||
<span class="sig-name descname"><span class="pre">average</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">complex</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.average" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.average">
|
||||
<span class="sig-name descname"><span class="pre">average</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">complex</span></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.average" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns average value of list</p>
|
||||
<section id="id3">
|
||||
<h3>Parameter<a class="headerlink" href="#id3" title="Permalink to this heading"></a></h3>
|
||||
@@ -263,8 +263,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.contains">
|
||||
<span class="sig-name descname"><span class="pre">contains</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.contains" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.contains">
|
||||
<span class="sig-name descname"><span class="pre">contains</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.contains" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Checks if list contains value given by function</p>
|
||||
<section id="id5">
|
||||
<h3>Parameter<a class="headerlink" href="#id5" title="Permalink to this heading"></a></h3>
|
||||
@@ -284,8 +284,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.count">
|
||||
<span class="sig-name descname"><span class="pre">count</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.count" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.count">
|
||||
<span class="sig-name descname"><span class="pre">count</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.count" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns length of list or count of found elements</p>
|
||||
<section id="id7">
|
||||
<h3>Parameter<a class="headerlink" href="#id7" title="Permalink to this heading"></a></h3>
|
||||
@@ -305,8 +305,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.distinct">
|
||||
<span class="sig-name descname"><span class="pre">distinct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.distinct" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.distinct">
|
||||
<span class="sig-name descname"><span class="pre">distinct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.queryable_abc.QueryableABC" title="cpl.query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.distinct" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns list without redundancies</p>
|
||||
<section id="id9">
|
||||
<h3>Parameter<a class="headerlink" href="#id9" title="Permalink to this heading"></a></h3>
|
||||
@@ -322,7 +322,7 @@
|
||||
<blockquote>
|
||||
<div><dl class="field-list simple">
|
||||
<dt class="field-odd">class<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||
<dd class="field-odd"><p><cite>cpl.query.base.queryable_abc.QueryableABC</cite></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -330,8 +330,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.element_at">
|
||||
<span class="sig-name descname"><span class="pre">element_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.element_at" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.element_at">
|
||||
<span class="sig-name descname"><span class="pre">element_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.element_at" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns element at given index</p>
|
||||
<section id="id11">
|
||||
<h3>Parameter<a class="headerlink" href="#id11" title="Permalink to this heading"></a></h3>
|
||||
@@ -351,8 +351,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.element_at_or_default">
|
||||
<span class="sig-name descname"><span class="pre">element_at_or_default</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.element_at_or_default" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.element_at_or_default">
|
||||
<span class="sig-name descname"><span class="pre">element_at_or_default</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.element_at_or_default" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns element at given index or None</p>
|
||||
<section id="id13">
|
||||
<h3>Parameter<a class="headerlink" href="#id13" title="Permalink to this heading"></a></h3>
|
||||
@@ -372,8 +372,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.first">
|
||||
<span class="sig-name descname"><span class="pre">first</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.first" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.first">
|
||||
<span class="sig-name descname"><span class="pre">first</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.first" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns first element</p>
|
||||
<section id="id15">
|
||||
<h3>Returns<a class="headerlink" href="#id15" title="Permalink to this heading"></a></h3>
|
||||
@@ -384,8 +384,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.first_or_default">
|
||||
<span class="sig-name descname"><span class="pre">first_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.first_or_default" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.first_or_default">
|
||||
<span class="sig-name descname"><span class="pre">first_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.first_or_default" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns first element or None</p>
|
||||
<section id="id16">
|
||||
<h3>Returns<a class="headerlink" href="#id16" title="Permalink to this heading"></a></h3>
|
||||
@@ -396,8 +396,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.for_each">
|
||||
<span class="sig-name descname"><span class="pre">for_each</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.for_each" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.for_each">
|
||||
<span class="sig-name descname"><span class="pre">for_each</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.for_each" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Runs given function for each element of list</p>
|
||||
<section id="id17">
|
||||
<h3>Parameter<a class="headerlink" href="#id17" title="Permalink to this heading"></a></h3>
|
||||
@@ -411,8 +411,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.group_by">
|
||||
<span class="sig-name descname"><span class="pre">group_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.group_by" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.group_by">
|
||||
<span class="sig-name descname"><span class="pre">group_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.queryable_abc.QueryableABC" title="cpl.query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.group_by" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Groups by func</p>
|
||||
<section id="id18">
|
||||
<h3>Returns<a class="headerlink" href="#id18" title="Permalink to this heading"></a></h3>
|
||||
@@ -423,8 +423,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.last">
|
||||
<span class="sig-name descname"><span class="pre">last</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.last" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.last">
|
||||
<span class="sig-name descname"><span class="pre">last</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.last" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns last element</p>
|
||||
<section id="id19">
|
||||
<h3>Returns<a class="headerlink" href="#id19" title="Permalink to this heading"></a></h3>
|
||||
@@ -435,8 +435,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.last_or_default">
|
||||
<span class="sig-name descname"><span class="pre">last_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.last_or_default" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.last_or_default">
|
||||
<span class="sig-name descname"><span class="pre">last_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.last_or_default" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns last element or None</p>
|
||||
<section id="id20">
|
||||
<h3>Returns<a class="headerlink" href="#id20" title="Permalink to this heading"></a></h3>
|
||||
@@ -447,8 +447,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.max">
|
||||
<span class="sig-name descname"><span class="pre">max</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.max" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.max">
|
||||
<span class="sig-name descname"><span class="pre">max</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.max" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns the highest value</p>
|
||||
<section id="id21">
|
||||
<h3>Parameter<a class="headerlink" href="#id21" title="Permalink to this heading"></a></h3>
|
||||
@@ -468,8 +468,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.median">
|
||||
<span class="sig-name descname"><span class="pre">median</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.median" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.median">
|
||||
<span class="sig-name descname"><span class="pre">median</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.median" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Return the median value of data elements</p>
|
||||
<section id="id23">
|
||||
<h3>Returns<a class="headerlink" href="#id23" title="Permalink to this heading"></a></h3>
|
||||
@@ -480,8 +480,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.min">
|
||||
<span class="sig-name descname"><span class="pre">min</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.min" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.min">
|
||||
<span class="sig-name descname"><span class="pre">min</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.min" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns the lowest value</p>
|
||||
<section id="id24">
|
||||
<h3>Parameter<a class="headerlink" href="#id24" title="Permalink to this heading"></a></h3>
|
||||
@@ -501,8 +501,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.order_by">
|
||||
<span class="sig-name descname"><span class="pre">order_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.order_by" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.order_by">
|
||||
<span class="sig-name descname"><span class="pre">order_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl.query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.order_by" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sorts elements by function in ascending order</p>
|
||||
<section id="id26">
|
||||
<h3>Parameter<a class="headerlink" href="#id26" title="Permalink to this heading"></a></h3>
|
||||
@@ -518,7 +518,7 @@
|
||||
<blockquote>
|
||||
<div><dl class="field-list simple">
|
||||
<dt class="field-odd">class<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><cite>cpl_query.base.ordered_queryable_abc.OrderedQueryableABC</cite></p>
|
||||
<dd class="field-odd"><p><cite>cpl.query.base.ordered_queryable_abc.OrderedQueryableABC</cite></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -526,8 +526,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.order_by_descending">
|
||||
<span class="sig-name descname"><span class="pre">order_by_descending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.order_by_descending" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.order_by_descending">
|
||||
<span class="sig-name descname"><span class="pre">order_by_descending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl.query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.order_by_descending" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sorts elements by function in descending order</p>
|
||||
<section id="id28">
|
||||
<h3>Parameter<a class="headerlink" href="#id28" title="Permalink to this heading"></a></h3>
|
||||
@@ -543,7 +543,7 @@
|
||||
<blockquote>
|
||||
<div><dl class="field-list simple">
|
||||
<dt class="field-odd">class<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><cite>cpl_query.base.ordered_queryable_abc.OrderedQueryableABC</cite></p>
|
||||
<dd class="field-odd"><p><cite>cpl.query.base.ordered_queryable_abc.OrderedQueryableABC</cite></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -551,15 +551,15 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.reverse">
|
||||
<span class="sig-name descname"><span class="pre">reverse</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.reverse" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.reverse">
|
||||
<span class="sig-name descname"><span class="pre">reverse</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.queryable_abc.QueryableABC" title="cpl.query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.reverse" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Reverses list</p>
|
||||
<section id="id30">
|
||||
<h3>Returns<a class="headerlink" href="#id30" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><dl class="field-list simple">
|
||||
<dt class="field-odd">class<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||
<dd class="field-odd"><p><cite>cpl.query.base.queryable_abc.QueryableABC</cite></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -567,15 +567,15 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.select">
|
||||
<span class="sig-name descname"><span class="pre">select</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.select" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.select">
|
||||
<span class="sig-name descname"><span class="pre">select</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.queryable_abc.QueryableABC" title="cpl.query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.select" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Formats each element of list to a given format</p>
|
||||
<section id="id31">
|
||||
<h3>Returns<a class="headerlink" href="#id31" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><dl class="field-list simple">
|
||||
<dt class="field-odd">class<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||
<dd class="field-odd"><p><cite>cpl.query.base.queryable_abc.QueryableABC</cite></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -583,15 +583,15 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.select_many">
|
||||
<span class="sig-name descname"><span class="pre">select_many</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.select_many" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.select_many">
|
||||
<span class="sig-name descname"><span class="pre">select_many</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.queryable_abc.QueryableABC" title="cpl.query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.select_many" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Flattens resulting lists to one</p>
|
||||
<section id="id32">
|
||||
<h3>Returns<a class="headerlink" href="#id32" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><dl class="field-list simple">
|
||||
<dt class="field-odd">class<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||
<dd class="field-odd"><p><cite>cpl.query.base.queryable_abc.QueryableABC</cite></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -599,8 +599,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.single">
|
||||
<span class="sig-name descname"><span class="pre">single</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.single" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.single">
|
||||
<span class="sig-name descname"><span class="pre">single</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.single" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns one single element of list</p>
|
||||
<section id="id33">
|
||||
<h3>Returns<a class="headerlink" href="#id33" title="Permalink to this heading"></a></h3>
|
||||
@@ -618,8 +618,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.single_or_default">
|
||||
<span class="sig-name descname"><span class="pre">single_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.single_or_default" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.single_or_default">
|
||||
<span class="sig-name descname"><span class="pre">single_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.single_or_default" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns one single element of list</p>
|
||||
<section id="id34">
|
||||
<h3>Returns<a class="headerlink" href="#id34" title="Permalink to this heading"></a></h3>
|
||||
@@ -630,8 +630,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.skip">
|
||||
<span class="sig-name descname"><span class="pre">skip</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.skip" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.skip">
|
||||
<span class="sig-name descname"><span class="pre">skip</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.queryable_abc.QueryableABC" title="cpl.query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.skip" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Skips all elements from index</p>
|
||||
<section id="id35">
|
||||
<h3>Parameter<a class="headerlink" href="#id35" title="Permalink to this heading"></a></h3>
|
||||
@@ -647,7 +647,7 @@ Exception: when argument is None or found more than one element</p>
|
||||
<blockquote>
|
||||
<div><dl class="field-list simple">
|
||||
<dt class="field-odd">class<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||
<dd class="field-odd"><p><cite>cpl.query.base.queryable_abc.QueryableABC</cite></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -655,8 +655,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.skip_last">
|
||||
<span class="sig-name descname"><span class="pre">skip_last</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.skip_last" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.skip_last">
|
||||
<span class="sig-name descname"><span class="pre">skip_last</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.queryable_abc.QueryableABC" title="cpl.query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.skip_last" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Skips all elements after index</p>
|
||||
<section id="id37">
|
||||
<h3>Parameter<a class="headerlink" href="#id37" title="Permalink to this heading"></a></h3>
|
||||
@@ -672,7 +672,7 @@ Exception: when argument is None or found more than one element</p>
|
||||
<blockquote>
|
||||
<div><dl class="field-list simple">
|
||||
<dt class="field-odd">class<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||
<dd class="field-odd"><p><cite>cpl.query.base.queryable_abc.QueryableABC</cite></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -680,8 +680,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.split">
|
||||
<span class="sig-name descname"><span class="pre">split</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.split" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.split">
|
||||
<span class="sig-name descname"><span class="pre">split</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.queryable_abc.QueryableABC" title="cpl.query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.split" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Splits the list by given function</p>
|
||||
<section id="id39">
|
||||
<h3>Parameter<a class="headerlink" href="#id39" title="Permalink to this heading"></a></h3>
|
||||
@@ -697,7 +697,7 @@ Exception: when argument is None or found more than one element</p>
|
||||
<blockquote>
|
||||
<div><dl class="field-list simple">
|
||||
<dt class="field-odd">class<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||
<dd class="field-odd"><p><cite>cpl.query.base.queryable_abc.QueryableABC</cite></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -705,8 +705,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.sum">
|
||||
<span class="sig-name descname"><span class="pre">sum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">complex</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.sum" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.sum">
|
||||
<span class="sig-name descname"><span class="pre">sum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">complex</span></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.sum" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sum of all values</p>
|
||||
<section id="id41">
|
||||
<h3>Parameter<a class="headerlink" href="#id41" title="Permalink to this heading"></a></h3>
|
||||
@@ -726,8 +726,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.take">
|
||||
<span class="sig-name descname"><span class="pre">take</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.take" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.take">
|
||||
<span class="sig-name descname"><span class="pre">take</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.queryable_abc.QueryableABC" title="cpl.query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.take" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Takes all elements from index</p>
|
||||
<section id="id43">
|
||||
<h3>Parameter<a class="headerlink" href="#id43" title="Permalink to this heading"></a></h3>
|
||||
@@ -743,7 +743,7 @@ Exception: when argument is None or found more than one element</p>
|
||||
<blockquote>
|
||||
<div><dl class="field-list simple">
|
||||
<dt class="field-odd">class<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||
<dd class="field-odd"><p><cite>cpl.query.base.queryable_abc.QueryableABC</cite></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -751,8 +751,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.take_last">
|
||||
<span class="sig-name descname"><span class="pre">take_last</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.take_last" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.take_last">
|
||||
<span class="sig-name descname"><span class="pre">take_last</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.queryable_abc.QueryableABC" title="cpl.query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.take_last" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Takes all elements after index</p>
|
||||
<section id="id45">
|
||||
<h3>Parameter<a class="headerlink" href="#id45" title="Permalink to this heading"></a></h3>
|
||||
@@ -768,7 +768,7 @@ Exception: when argument is None or found more than one element</p>
|
||||
<blockquote>
|
||||
<div><dl class="field-list simple">
|
||||
<dt class="field-odd">class<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||
<dd class="field-odd"><p><cite>cpl.query.base.queryable_abc.QueryableABC</cite></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -776,8 +776,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.where">
|
||||
<span class="sig-name descname"><span class="pre">where</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.where" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.queryable_abc.QueryableABC.where">
|
||||
<span class="sig-name descname"><span class="pre">where</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.queryable_abc.QueryableABC" title="cpl.query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl.query.base.queryable_abc.QueryableABC.where" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Select element by function</p>
|
||||
<section id="id47">
|
||||
<h3>Parameter<a class="headerlink" href="#id47" title="Permalink to this heading"></a></h3>
|
||||
@@ -793,7 +793,7 @@ Exception: when argument is None or found more than one element</p>
|
||||
<blockquote>
|
||||
<div><dl class="field-list simple">
|
||||
<dt class="field-odd">class<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||
<dd class="field-odd"><p><cite>cpl.query.base.queryable_abc.QueryableABC</cite></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -803,15 +803,15 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_query.base.sequence">
|
||||
<span id="cpl-query-base-sequence-module"></span><h2>cpl_query.base.sequence module<a class="headerlink" href="#module-cpl_query.base.sequence" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.query.base.sequence">
|
||||
<span id="cpl-query-base-sequence-module"></span><h2>cpl.query.base.sequence module<a class="headerlink" href="#module-cpl.query.base.sequence" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.sequence.Sequence">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.sequence.</span></span><span class="sig-name descname"><span class="pre">Sequence</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.sequence.Sequence" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.sequence.Sequence">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.query.base.sequence.</span></span><span class="sig-name descname"><span class="pre">Sequence</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.query.base.sequence.Sequence" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.sequence.Sequence.copy">
|
||||
<span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.sequence.Sequence" title="cpl_query.base.sequence.Sequence"><span class="pre">Sequence</span></a></span></span><a class="headerlink" href="#cpl_query.base.sequence.Sequence.copy" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.sequence.Sequence.copy">
|
||||
<span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.sequence.Sequence" title="cpl.query.base.sequence.Sequence"><span class="pre">Sequence</span></a></span></span><a class="headerlink" href="#cpl.query.base.sequence.Sequence.copy" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates a copy of sequence</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Sequence</p>
|
||||
@@ -820,8 +820,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.sequence.Sequence.empty">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">empty</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.sequence.Sequence" title="cpl_query.base.sequence.Sequence"><span class="pre">Sequence</span></a></span></span><a class="headerlink" href="#cpl_query.base.sequence.Sequence.empty" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.sequence.Sequence.empty">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">empty</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.sequence.Sequence" title="cpl.query.base.sequence.Sequence"><span class="pre">Sequence</span></a></span></span><a class="headerlink" href="#cpl.query.base.sequence.Sequence.empty" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns an empty sequence</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Sequence object that contains no elements</p>
|
||||
@@ -830,8 +830,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.sequence.Sequence.index_of">
|
||||
<span class="sig-name descname"><span class="pre">index_of</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_object</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#cpl_query.base.sequence.Sequence.index_of" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.sequence.Sequence.index_of">
|
||||
<span class="sig-name descname"><span class="pre">index_of</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_object</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#cpl.query.base.sequence.Sequence.index_of" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns the index of given element</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Index of object</p>
|
||||
@@ -842,14 +842,14 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.sequence.Sequence.range">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">length</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.sequence.Sequence" title="cpl_query.base.sequence.Sequence"><span class="pre">Sequence</span></a></span></span><a class="headerlink" href="#cpl_query.base.sequence.Sequence.range" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.sequence.Sequence.range">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">length</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.base.sequence.Sequence" title="cpl.query.base.sequence.Sequence"><span class="pre">Sequence</span></a></span></span><a class="headerlink" href="#cpl.query.base.sequence.Sequence.range" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.sequence.Sequence.to_list">
|
||||
<span class="sig-name descname"><span class="pre">to_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#cpl_query.base.sequence.Sequence.to_list" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts :class: <cite>cpl_query.base.sequence_abc.SequenceABC</cite> to :class: <cite>list</cite></p>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.sequence.Sequence.to_list">
|
||||
<span class="sig-name descname"><span class="pre">to_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#cpl.query.base.sequence.Sequence.to_list" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts :class: <cite>cpl.query.base.sequence_abc.SequenceABC</cite> to :class: <cite>list</cite></p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><dl class="field-list simple">
|
||||
<dt class="field-odd">class<span class="colon">:</span></dt>
|
||||
@@ -861,15 +861,15 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.sequence.Sequence.type">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span></em><a class="headerlink" href="#cpl_query.base.sequence.Sequence.type" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.sequence.Sequence.type">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span></em><a class="headerlink" href="#cpl.query.base.sequence.Sequence.type" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_query.base">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_query.base" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.query.base">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl.query.base" title="Permalink to this heading"></a></h2>
|
||||
<section id="cpl-query-cpl-queries">
|
||||
<h3>cpl-query CPL Queries<a class="headerlink" href="#cpl-query-cpl-queries" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL Python integrated Queries</p>
|
||||
@@ -885,24 +885,24 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.query.base.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.query.base.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_query.base.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl.query.base.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_query.base.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl.query.base.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_query.base.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_query.base.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.base.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl.query.base.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
@@ -915,8 +915,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_query.html" class="btn btn-neutral float-left" title="Query reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_query.enumerable.html" class="btn btn-neutral float-right" title="cpl_query.enumerable package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.query.html" class="btn btn-neutral float-left" title="Query reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl.query.enumerable.html" class="btn btn-neutral float-right" title="cpl.query.enumerable package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
92
docs/build/html/cpl_query.enumerable.html
vendored
92
docs/build/html/cpl_query.enumerable.html
vendored
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_query.enumerable package — Common Python Library documentation</title>
|
||||
<title>cpl.query.enumerable package — Common Python Library documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -19,8 +19,8 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="cpl_query.extension package" href="cpl_query.extension.html" />
|
||||
<link rel="prev" title="cpl_query.base package" href="cpl_query.base.html" />
|
||||
<link rel="next" title="cpl.query.extension package" href="cpl.query.extension.html" />
|
||||
<link rel="prev" title="cpl.query.base package" href="cpl.query.base.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -48,29 +48,29 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_query.html">Query reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html">cpl_query.base package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_query.enumerable package</a><ul>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl.query.html">Query reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.base.html">cpl.query.base package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.query.enumerable package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.enumerable.enumerable">cpl_query.enumerable.enumerable module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.enumerable.enumerable.Enumerable"><code class="docutils literal notranslate"><span class="pre">Enumerable</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.query.enumerable.enumerable">cpl.query.enumerable.enumerable module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.query.enumerable.enumerable.Enumerable"><code class="docutils literal notranslate"><span class="pre">Enumerable</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.enumerable.enumerable_abc">cpl_query.enumerable.enumerable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.enumerable.enumerable_abc.EnumerableABC"><code class="docutils literal notranslate"><span class="pre">EnumerableABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.query.enumerable.enumerable_abc">cpl.query.enumerable.enumerable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.query.enumerable.enumerable_abc.EnumerableABC"><code class="docutils literal notranslate"><span class="pre">EnumerableABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.enumerable">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.query.enumerable">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.enumerable.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.query.enumerable.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.extension.html">cpl_query.extension package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.iterable.html">cpl_query.iterable package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.extension.html">cpl.query.extension package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.iterable.html">cpl.query.iterable package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
@@ -90,10 +90,10 @@
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_query.html">Query reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl_query.enumerable package</li>
|
||||
<li class="breadcrumb-item"><a href="cpl.query.html">Query reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl.query.enumerable package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_query.enumerable.rst.txt" rel="nofollow"> View page source</a>
|
||||
<a href="_sources/cpl.query.enumerable.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -102,35 +102,35 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="cpl-query-enumerable-package">
|
||||
<h1>cpl_query.enumerable package<a class="headerlink" href="#cpl-query-enumerable-package" title="Permalink to this heading"></a></h1>
|
||||
<h1>cpl.query.enumerable package<a class="headerlink" href="#cpl-query-enumerable-package" title="Permalink to this heading"></a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_query.enumerable.enumerable">
|
||||
<span id="cpl-query-enumerable-enumerable-module"></span><h2>cpl_query.enumerable.enumerable module<a class="headerlink" href="#module-cpl_query.enumerable.enumerable" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.query.enumerable.enumerable">
|
||||
<span id="cpl-query-enumerable-enumerable-module"></span><h2>cpl.query.enumerable.enumerable module<a class="headerlink" href="#module-cpl.query.enumerable.enumerable" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_query.enumerable.enumerable.Enumerable">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.enumerable.enumerable.</span></span><span class="sig-name descname"><span class="pre">Enumerable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.enumerable.enumerable.Enumerable" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_query.enumerable.enumerable_abc.EnumerableABC" title="cpl_query.enumerable.enumerable_abc.EnumerableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EnumerableABC</span></code></a></p>
|
||||
<p>Implementation of :class: <cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite></p>
|
||||
<dt class="sig sig-object py" id="cpl.query.enumerable.enumerable.Enumerable">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.query.enumerable.enumerable.</span></span><span class="sig-name descname"><span class="pre">Enumerable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.query.enumerable.enumerable.Enumerable" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.query.enumerable.enumerable_abc.EnumerableABC" title="cpl.query.enumerable.enumerable_abc.EnumerableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EnumerableABC</span></code></a></p>
|
||||
<p>Implementation of :class: <cite>cpl.query.enumerable.enumerable_abc.EnumerableABC</cite></p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_query.enumerable.enumerable_abc">
|
||||
<span id="cpl-query-enumerable-enumerable-abc-module"></span><h2>cpl_query.enumerable.enumerable_abc module<a class="headerlink" href="#module-cpl_query.enumerable.enumerable_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.query.enumerable.enumerable_abc">
|
||||
<span id="cpl-query-enumerable-enumerable-abc-module"></span><h2>cpl.query.enumerable.enumerable_abc module<a class="headerlink" href="#module-cpl.query.enumerable.enumerable_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_query.enumerable.enumerable_abc.EnumerableABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.enumerable.enumerable_abc.</span></span><span class="sig-name descname"><span class="pre">EnumerableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.enumerable.enumerable_abc.EnumerableABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryableABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.query.enumerable.enumerable_abc.EnumerableABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.query.enumerable.enumerable_abc.</span></span><span class="sig-name descname"><span class="pre">EnumerableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.query.enumerable.enumerable_abc.EnumerableABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC" title="cpl.query.base.queryable_abc.QueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryableABC</span></code></a></p>
|
||||
<p>ABC to define functions on list</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.enumerable.enumerable_abc.EnumerableABC.to_iterable">
|
||||
<span class="sig-name descname"><span class="pre">to_iterable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable_abc.IterableABC" title="cpl_query.iterable.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.enumerable.enumerable_abc.EnumerableABC.to_iterable" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts :class: <cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite> to :class: <cite>cpl_query.iterable.iterable_abc.IterableABC</cite></p>
|
||||
<dt class="sig sig-object py" id="cpl.query.enumerable.enumerable_abc.EnumerableABC.to_iterable">
|
||||
<span class="sig-name descname"><span class="pre">to_iterable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl.query.iterable.html#cpl.query.iterable.iterable_abc.IterableABC" title="cpl.query.iterable.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl.query.enumerable.enumerable_abc.EnumerableABC.to_iterable" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts :class: <cite>cpl.query.enumerable.enumerable_abc.EnumerableABC</cite> to :class: <cite>cpl.query.iterable.iterable_abc.IterableABC</cite></p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><dl class="field-list simple">
|
||||
<dt class="field-odd">class<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><cite>cpl_query.iterable.iterable_abc.IterableABC</cite></p>
|
||||
<dd class="field-odd"><p><cite>cpl.query.iterable.iterable_abc.IterableABC</cite></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
@@ -140,8 +140,8 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_query.enumerable">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_query.enumerable" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.query.enumerable">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl.query.enumerable" title="Permalink to this heading"></a></h2>
|
||||
<section id="cpl-query-cpl-queries">
|
||||
<h3>cpl-query CPL Queries<a class="headerlink" href="#cpl-query-cpl-queries" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL Python integrated Queries</p>
|
||||
@@ -157,24 +157,24 @@
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_query.enumerable.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.enumerable.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.enumerable.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.enumerable.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.query.enumerable.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.query.enumerable.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_query.enumerable.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_query.enumerable.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.enumerable.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl.query.enumerable.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_query.enumerable.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_query.enumerable.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.enumerable.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl.query.enumerable.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_query.enumerable.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_query.enumerable.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.enumerable.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl.query.enumerable.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
@@ -187,8 +187,8 @@
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_query.base.html" class="btn btn-neutral float-left" title="cpl_query.base package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_query.extension.html" class="btn btn-neutral float-right" title="cpl_query.extension package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.query.base.html" class="btn btn-neutral float-left" title="cpl.query.base package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl.query.extension.html" class="btn btn-neutral float-right" title="cpl.query.extension package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
86
docs/build/html/cpl_query.extension.html
vendored
86
docs/build/html/cpl_query.extension.html
vendored
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_query.extension package — Common Python Library documentation</title>
|
||||
<title>cpl.query.extension package — Common Python Library documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -19,8 +19,8 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="cpl_query.iterable package" href="cpl_query.iterable.html" />
|
||||
<link rel="prev" title="cpl_query.enumerable package" href="cpl_query.enumerable.html" />
|
||||
<link rel="next" title="cpl.query.iterable package" href="cpl.query.iterable.html" />
|
||||
<link rel="prev" title="cpl.query.enumerable package" href="cpl.query.enumerable.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -48,25 +48,25 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_query.html">Query reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html">cpl_query.base package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html">cpl_query.enumerable package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_query.extension package</a><ul>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl.query.html">Query reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.base.html">cpl.query.base package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.enumerable.html">cpl.query.enumerable package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.query.extension package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.extension.list">cpl_query.extension.list module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.extension.list.List"><code class="docutils literal notranslate"><span class="pre">List</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.query.extension.list">cpl.query.extension.list module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.query.extension.list.List"><code class="docutils literal notranslate"><span class="pre">List</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.extension">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.query.extension">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.extension.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.query.extension.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.iterable.html">cpl_query.iterable package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.iterable.html">cpl.query.iterable package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
@@ -86,10 +86,10 @@
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_query.html">Query reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl_query.extension package</li>
|
||||
<li class="breadcrumb-item"><a href="cpl.query.html">Query reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl.query.extension package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_query.extension.rst.txt" rel="nofollow"> View page source</a>
|
||||
<a href="_sources/cpl.query.extension.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -98,25 +98,25 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="cpl-query-extension-package">
|
||||
<h1>cpl_query.extension package<a class="headerlink" href="#cpl-query-extension-package" title="Permalink to this heading"></a></h1>
|
||||
<h1>cpl.query.extension package<a class="headerlink" href="#cpl-query-extension-package" title="Permalink to this heading"></a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_query.extension.list">
|
||||
<span id="cpl-query-extension-list-module"></span><h2>cpl_query.extension.list module<a class="headerlink" href="#module-cpl_query.extension.list" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.query.extension.list">
|
||||
<span id="cpl-query-extension-list-module"></span><h2>cpl.query.extension.list module<a class="headerlink" href="#module-cpl.query.extension.list" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.list.List">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.extension.list.</span></span><span class="sig-name descname"><span class="pre">List</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterator</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.list.List" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable.Iterable" title="cpl_query.iterable.iterable.Iterable"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code></a></p>
|
||||
<p>Implementation of :class: <cite>cpl_query.extension.iterable.Iterable</cite></p>
|
||||
<dt class="sig sig-object py" id="cpl.query.extension.list.List">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.query.extension.list.</span></span><span class="sig-name descname"><span class="pre">List</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterator</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.query.extension.list.List" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.query.iterable.html#cpl.query.iterable.iterable.Iterable" title="cpl.query.iterable.iterable.Iterable"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code></a></p>
|
||||
<p>Implementation of :class: <cite>cpl.query.extension.iterable.Iterable</cite></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.list.List.to_enumerable">
|
||||
<span class="sig-name descname"><span class="pre">to_enumerable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.enumerable_abc.EnumerableABC" title="cpl_query.enumerable.enumerable_abc.EnumerableABC"><span class="pre">EnumerableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.list.List.to_enumerable" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts :class: <cite>cpl_query.iterable.iterable_abc.IterableABC</cite> to :class: <cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite></p>
|
||||
<dt class="sig sig-object py" id="cpl.query.extension.list.List.to_enumerable">
|
||||
<span class="sig-name descname"><span class="pre">to_enumerable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl.query.enumerable.html#cpl.query.enumerable.enumerable_abc.EnumerableABC" title="cpl.query.enumerable.enumerable_abc.EnumerableABC"><span class="pre">EnumerableABC</span></a></span></span><a class="headerlink" href="#cpl.query.extension.list.List.to_enumerable" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts :class: <cite>cpl.query.iterable.iterable_abc.IterableABC</cite> to :class: <cite>cpl.query.enumerable.enumerable_abc.EnumerableABC</cite></p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><dl class="field-list simple">
|
||||
<dt class="field-odd">class<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite></p>
|
||||
<dd class="field-odd"><p><cite>cpl.query.enumerable.enumerable_abc.EnumerableABC</cite></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
@@ -124,13 +124,13 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.list.List.to_iterable">
|
||||
<span class="sig-name descname"><span class="pre">to_iterable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable_abc.IterableABC" title="cpl_query.iterable.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.list.List.to_iterable" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts :class: <cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite> to :class: <cite>cpl_query.iterable.iterable_abc.IterableABC</cite></p>
|
||||
<dt class="sig sig-object py" id="cpl.query.extension.list.List.to_iterable">
|
||||
<span class="sig-name descname"><span class="pre">to_iterable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl.query.iterable.html#cpl.query.iterable.iterable_abc.IterableABC" title="cpl.query.iterable.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl.query.extension.list.List.to_iterable" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts :class: <cite>cpl.query.enumerable.enumerable_abc.EnumerableABC</cite> to :class: <cite>cpl.query.iterable.iterable_abc.IterableABC</cite></p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><dl class="field-list simple">
|
||||
<dt class="field-odd">class<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><cite>cpl_query.iterable.iterable_abc.IterableABC</cite></p>
|
||||
<dd class="field-odd"><p><cite>cpl.query.iterable.iterable_abc.IterableABC</cite></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
@@ -140,8 +140,8 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_query.extension">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_query.extension" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.query.extension">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl.query.extension" title="Permalink to this heading"></a></h2>
|
||||
<section id="cpl-query-cpl-queries">
|
||||
<h3>cpl-query CPL Queries<a class="headerlink" href="#cpl-query-cpl-queries" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL Python integrated Queries</p>
|
||||
@@ -157,24 +157,24 @@
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.extension.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.extension.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.query.extension.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.query.extension.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_query.extension.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.extension.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl.query.extension.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_query.extension.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.extension.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl.query.extension.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_query.extension.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.extension.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl.query.extension.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
@@ -187,8 +187,8 @@
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_query.enumerable.html" class="btn btn-neutral float-left" title="cpl_query.enumerable package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_query.iterable.html" class="btn btn-neutral float-right" title="cpl_query.iterable package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.query.enumerable.html" class="btn btn-neutral float-left" title="cpl.query.enumerable package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl.query.iterable.html" class="btn btn-neutral float-right" title="cpl.query.iterable package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
220
docs/build/html/cpl_query.html
vendored
220
docs/build/html/cpl_query.html
vendored
@@ -19,7 +19,7 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="cpl_query.base package" href="cpl_query.base.html" />
|
||||
<link rel="next" title="cpl.query.base package" href="cpl.query.base.html" />
|
||||
<link rel="prev" title="cpl_discord.service package" href="cpl_discord.service.html" />
|
||||
</head>
|
||||
|
||||
@@ -48,13 +48,13 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Query reference</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html">cpl_query.base package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html">cpl_query.enumerable package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.extension.html">cpl_query.extension package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.iterable.html">cpl_query.iterable package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.base.html">cpl.query.base package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.enumerable.html">cpl.query.enumerable package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.extension.html">cpl.query.extension package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.iterable.html">cpl.query.iterable package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
@@ -76,7 +76,7 @@
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item active">Query reference</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_query.rst.txt" rel="nofollow"> View page source</a>
|
||||
<a href="_sources/cpl.query.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -88,160 +88,160 @@
|
||||
<h1>Query reference<a class="headerlink" href="#query-reference" title="Permalink to this heading"></a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.base.html">cpl_query.base package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.default_lambda">cpl_query.base.default_lambda module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.default_lambda.default_lambda"><code class="docutils literal notranslate"><span class="pre">default_lambda()</span></code></a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.base.html">cpl.query.base package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.base.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.base.html#module-cpl.query.base.default_lambda">cpl.query.base.default_lambda module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.default_lambda.default_lambda"><code class="docutils literal notranslate"><span class="pre">default_lambda()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.ordered_queryable">cpl_query.base.ordered_queryable module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.ordered_queryable.OrderedQueryable"><code class="docutils literal notranslate"><span class="pre">OrderedQueryable</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.ordered_queryable.OrderedQueryable.then_by"><code class="docutils literal notranslate"><span class="pre">OrderedQueryable.then_by()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.ordered_queryable.OrderedQueryable.then_by_descending"><code class="docutils literal notranslate"><span class="pre">OrderedQueryable.then_by_descending()</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.base.html#module-cpl.query.base.ordered_queryable">cpl.query.base.ordered_queryable module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.ordered_queryable.OrderedQueryable"><code class="docutils literal notranslate"><span class="pre">OrderedQueryable</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.ordered_queryable.OrderedQueryable.then_by"><code class="docutils literal notranslate"><span class="pre">OrderedQueryable.then_by()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.ordered_queryable.OrderedQueryable.then_by_descending"><code class="docutils literal notranslate"><span class="pre">OrderedQueryable.then_by_descending()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.ordered_queryable_abc">cpl_query.base.ordered_queryable_abc module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="docutils literal notranslate"><span class="pre">OrderedQueryableABC</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC.then_by"><code class="docutils literal notranslate"><span class="pre">OrderedQueryableABC.then_by()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC.then_by_descending"><code class="docutils literal notranslate"><span class="pre">OrderedQueryableABC.then_by_descending()</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.base.html#module-cpl.query.base.ordered_queryable_abc">cpl.query.base.ordered_queryable_abc module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="docutils literal notranslate"><span class="pre">OrderedQueryableABC</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.ordered_queryable_abc.OrderedQueryableABC.then_by"><code class="docutils literal notranslate"><span class="pre">OrderedQueryableABC.then_by()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.ordered_queryable_abc.OrderedQueryableABC.then_by_descending"><code class="docutils literal notranslate"><span class="pre">OrderedQueryableABC.then_by_descending()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.queryable_abc">cpl_query.base.queryable_abc module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC"><code class="docutils literal notranslate"><span class="pre">QueryableABC</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.all"><code class="docutils literal notranslate"><span class="pre">QueryableABC.all()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.any"><code class="docutils literal notranslate"><span class="pre">QueryableABC.any()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.average"><code class="docutils literal notranslate"><span class="pre">QueryableABC.average()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.contains"><code class="docutils literal notranslate"><span class="pre">QueryableABC.contains()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.count"><code class="docutils literal notranslate"><span class="pre">QueryableABC.count()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.distinct"><code class="docutils literal notranslate"><span class="pre">QueryableABC.distinct()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.element_at"><code class="docutils literal notranslate"><span class="pre">QueryableABC.element_at()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.element_at_or_default"><code class="docutils literal notranslate"><span class="pre">QueryableABC.element_at_or_default()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.first"><code class="docutils literal notranslate"><span class="pre">QueryableABC.first()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.first_or_default"><code class="docutils literal notranslate"><span class="pre">QueryableABC.first_or_default()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.for_each"><code class="docutils literal notranslate"><span class="pre">QueryableABC.for_each()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.group_by"><code class="docutils literal notranslate"><span class="pre">QueryableABC.group_by()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.last"><code class="docutils literal notranslate"><span class="pre">QueryableABC.last()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.last_or_default"><code class="docutils literal notranslate"><span class="pre">QueryableABC.last_or_default()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.max"><code class="docutils literal notranslate"><span class="pre">QueryableABC.max()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.median"><code class="docutils literal notranslate"><span class="pre">QueryableABC.median()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.min"><code class="docutils literal notranslate"><span class="pre">QueryableABC.min()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.order_by"><code class="docutils literal notranslate"><span class="pre">QueryableABC.order_by()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.order_by_descending"><code class="docutils literal notranslate"><span class="pre">QueryableABC.order_by_descending()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.reverse"><code class="docutils literal notranslate"><span class="pre">QueryableABC.reverse()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.select"><code class="docutils literal notranslate"><span class="pre">QueryableABC.select()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.select_many"><code class="docutils literal notranslate"><span class="pre">QueryableABC.select_many()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.single"><code class="docutils literal notranslate"><span class="pre">QueryableABC.single()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.single_or_default"><code class="docutils literal notranslate"><span class="pre">QueryableABC.single_or_default()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.skip"><code class="docutils literal notranslate"><span class="pre">QueryableABC.skip()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.skip_last"><code class="docutils literal notranslate"><span class="pre">QueryableABC.skip_last()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.split"><code class="docutils literal notranslate"><span class="pre">QueryableABC.split()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.sum"><code class="docutils literal notranslate"><span class="pre">QueryableABC.sum()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.take"><code class="docutils literal notranslate"><span class="pre">QueryableABC.take()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.take_last"><code class="docutils literal notranslate"><span class="pre">QueryableABC.take_last()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.where"><code class="docutils literal notranslate"><span class="pre">QueryableABC.where()</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.base.html#module-cpl.query.base.queryable_abc">cpl.query.base.queryable_abc module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC"><code class="docutils literal notranslate"><span class="pre">QueryableABC</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.all"><code class="docutils literal notranslate"><span class="pre">QueryableABC.all()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.any"><code class="docutils literal notranslate"><span class="pre">QueryableABC.any()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.average"><code class="docutils literal notranslate"><span class="pre">QueryableABC.average()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.contains"><code class="docutils literal notranslate"><span class="pre">QueryableABC.contains()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.count"><code class="docutils literal notranslate"><span class="pre">QueryableABC.count()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.distinct"><code class="docutils literal notranslate"><span class="pre">QueryableABC.distinct()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.element_at"><code class="docutils literal notranslate"><span class="pre">QueryableABC.element_at()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.element_at_or_default"><code class="docutils literal notranslate"><span class="pre">QueryableABC.element_at_or_default()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.first"><code class="docutils literal notranslate"><span class="pre">QueryableABC.first()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.first_or_default"><code class="docutils literal notranslate"><span class="pre">QueryableABC.first_or_default()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.for_each"><code class="docutils literal notranslate"><span class="pre">QueryableABC.for_each()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.group_by"><code class="docutils literal notranslate"><span class="pre">QueryableABC.group_by()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.last"><code class="docutils literal notranslate"><span class="pre">QueryableABC.last()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.last_or_default"><code class="docutils literal notranslate"><span class="pre">QueryableABC.last_or_default()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.max"><code class="docutils literal notranslate"><span class="pre">QueryableABC.max()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.median"><code class="docutils literal notranslate"><span class="pre">QueryableABC.median()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.min"><code class="docutils literal notranslate"><span class="pre">QueryableABC.min()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.order_by"><code class="docutils literal notranslate"><span class="pre">QueryableABC.order_by()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.order_by_descending"><code class="docutils literal notranslate"><span class="pre">QueryableABC.order_by_descending()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.reverse"><code class="docutils literal notranslate"><span class="pre">QueryableABC.reverse()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.select"><code class="docutils literal notranslate"><span class="pre">QueryableABC.select()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.select_many"><code class="docutils literal notranslate"><span class="pre">QueryableABC.select_many()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.single"><code class="docutils literal notranslate"><span class="pre">QueryableABC.single()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.single_or_default"><code class="docutils literal notranslate"><span class="pre">QueryableABC.single_or_default()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.skip"><code class="docutils literal notranslate"><span class="pre">QueryableABC.skip()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.skip_last"><code class="docutils literal notranslate"><span class="pre">QueryableABC.skip_last()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.split"><code class="docutils literal notranslate"><span class="pre">QueryableABC.split()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.sum"><code class="docutils literal notranslate"><span class="pre">QueryableABC.sum()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.take"><code class="docutils literal notranslate"><span class="pre">QueryableABC.take()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.take_last"><code class="docutils literal notranslate"><span class="pre">QueryableABC.take_last()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC.where"><code class="docutils literal notranslate"><span class="pre">QueryableABC.where()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.sequence">cpl_query.base.sequence module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.sequence.Sequence"><code class="docutils literal notranslate"><span class="pre">Sequence</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.sequence.Sequence.copy"><code class="docutils literal notranslate"><span class="pre">Sequence.copy()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.sequence.Sequence.empty"><code class="docutils literal notranslate"><span class="pre">Sequence.empty()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.sequence.Sequence.index_of"><code class="docutils literal notranslate"><span class="pre">Sequence.index_of()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.sequence.Sequence.range"><code class="docutils literal notranslate"><span class="pre">Sequence.range()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.sequence.Sequence.to_list"><code class="docutils literal notranslate"><span class="pre">Sequence.to_list()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.sequence.Sequence.type"><code class="docutils literal notranslate"><span class="pre">Sequence.type</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.base.html#module-cpl.query.base.sequence">cpl.query.base.sequence module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.sequence.Sequence"><code class="docutils literal notranslate"><span class="pre">Sequence</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.sequence.Sequence.copy"><code class="docutils literal notranslate"><span class="pre">Sequence.copy()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.sequence.Sequence.empty"><code class="docutils literal notranslate"><span class="pre">Sequence.empty()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.sequence.Sequence.index_of"><code class="docutils literal notranslate"><span class="pre">Sequence.index_of()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.sequence.Sequence.range"><code class="docutils literal notranslate"><span class="pre">Sequence.range()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.sequence.Sequence.to_list"><code class="docutils literal notranslate"><span class="pre">Sequence.to_list()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.sequence.Sequence.type"><code class="docutils literal notranslate"><span class="pre">Sequence.type</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.base.html#module-cpl.query.base">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.base.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.enumerable.html">cpl_query.enumerable package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html#module-cpl_query.enumerable.enumerable">cpl_query.enumerable.enumerable module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.enumerable.Enumerable"><code class="docutils literal notranslate"><span class="pre">Enumerable</span></code></a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.enumerable.html">cpl.query.enumerable package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.enumerable.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.enumerable.html#module-cpl.query.enumerable.enumerable">cpl.query.enumerable.enumerable module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.enumerable.html#cpl.query.enumerable.enumerable.Enumerable"><code class="docutils literal notranslate"><span class="pre">Enumerable</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html#module-cpl_query.enumerable.enumerable_abc">cpl_query.enumerable.enumerable_abc module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.enumerable_abc.EnumerableABC"><code class="docutils literal notranslate"><span class="pre">EnumerableABC</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.enumerable_abc.EnumerableABC.to_iterable"><code class="docutils literal notranslate"><span class="pre">EnumerableABC.to_iterable()</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.enumerable.html#module-cpl.query.enumerable.enumerable_abc">cpl.query.enumerable.enumerable_abc module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.enumerable.html#cpl.query.enumerable.enumerable_abc.EnumerableABC"><code class="docutils literal notranslate"><span class="pre">EnumerableABC</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.enumerable.html#cpl.query.enumerable.enumerable_abc.EnumerableABC.to_iterable"><code class="docutils literal notranslate"><span class="pre">EnumerableABC.to_iterable()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html#module-cpl_query.enumerable">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.enumerable.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.enumerable.html#module-cpl.query.enumerable">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.enumerable.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.enumerable.html#cpl.query.enumerable.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.enumerable.html#cpl.query.enumerable.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.enumerable.html#cpl.query.enumerable.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.enumerable.html#cpl.query.enumerable.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.extension.html">cpl_query.extension package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.extension.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.extension.html#module-cpl_query.extension.list">cpl_query.extension.list module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.list.List"><code class="docutils literal notranslate"><span class="pre">List</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.list.List.to_enumerable"><code class="docutils literal notranslate"><span class="pre">List.to_enumerable()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.list.List.to_iterable"><code class="docutils literal notranslate"><span class="pre">List.to_iterable()</span></code></a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.extension.html">cpl.query.extension package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.extension.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.extension.html#module-cpl.query.extension.list">cpl.query.extension.list module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.extension.html#cpl.query.extension.list.List"><code class="docutils literal notranslate"><span class="pre">List</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.extension.html#cpl.query.extension.list.List.to_enumerable"><code class="docutils literal notranslate"><span class="pre">List.to_enumerable()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.extension.html#cpl.query.extension.list.List.to_iterable"><code class="docutils literal notranslate"><span class="pre">List.to_iterable()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.extension.html#module-cpl_query.extension">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.extension.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.extension.html#module-cpl.query.extension">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.extension.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.extension.html#cpl.query.extension.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.extension.html#cpl.query.extension.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.extension.html#cpl.query.extension.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.extension.html#cpl.query.extension.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.iterable.html">cpl_query.iterable package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.iterable.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.iterable.html#module-cpl_query.iterable.iterable">cpl_query.iterable.iterable module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable.Iterable"><code class="docutils literal notranslate"><span class="pre">Iterable</span></code></a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.iterable.html">cpl.query.iterable package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.iterable.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.iterable.html#module-cpl.query.iterable.iterable">cpl.query.iterable.iterable module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.iterable.html#cpl.query.iterable.iterable.Iterable"><code class="docutils literal notranslate"><span class="pre">Iterable</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.iterable.html#module-cpl_query.iterable.iterable_abc">cpl_query.iterable.iterable_abc module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable_abc.IterableABC"><code class="docutils literal notranslate"><span class="pre">IterableABC</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable_abc.IterableABC.add"><code class="docutils literal notranslate"><span class="pre">IterableABC.add()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable_abc.IterableABC.append"><code class="docutils literal notranslate"><span class="pre">IterableABC.append()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable_abc.IterableABC.extend"><code class="docutils literal notranslate"><span class="pre">IterableABC.extend()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable_abc.IterableABC.remove"><code class="docutils literal notranslate"><span class="pre">IterableABC.remove()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable_abc.IterableABC.remove_at"><code class="docutils literal notranslate"><span class="pre">IterableABC.remove_at()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable_abc.IterableABC.to_enumerable"><code class="docutils literal notranslate"><span class="pre">IterableABC.to_enumerable()</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.iterable.html#module-cpl.query.iterable.iterable_abc">cpl.query.iterable.iterable_abc module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.iterable.html#cpl.query.iterable.iterable_abc.IterableABC"><code class="docutils literal notranslate"><span class="pre">IterableABC</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.iterable.html#cpl.query.iterable.iterable_abc.IterableABC.add"><code class="docutils literal notranslate"><span class="pre">IterableABC.add()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.iterable.html#cpl.query.iterable.iterable_abc.IterableABC.append"><code class="docutils literal notranslate"><span class="pre">IterableABC.append()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.iterable.html#cpl.query.iterable.iterable_abc.IterableABC.extend"><code class="docutils literal notranslate"><span class="pre">IterableABC.extend()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.iterable.html#cpl.query.iterable.iterable_abc.IterableABC.remove"><code class="docutils literal notranslate"><span class="pre">IterableABC.remove()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.iterable.html#cpl.query.iterable.iterable_abc.IterableABC.remove_at"><code class="docutils literal notranslate"><span class="pre">IterableABC.remove_at()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.iterable.html#cpl.query.iterable.iterable_abc.IterableABC.to_enumerable"><code class="docutils literal notranslate"><span class="pre">IterableABC.to_enumerable()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.iterable.html#module-cpl_query.iterable">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.iterable.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.iterable.html#module-cpl.query.iterable">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.iterable.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.iterable.html#cpl.query.iterable.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.iterable.html#cpl.query.iterable.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.iterable.html#cpl.query.iterable.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.iterable.html#cpl.query.iterable.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -257,7 +257,7 @@
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_discord.service.html" class="btn btn-neutral float-left" title="cpl_discord.service package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_query.base.html" class="btn btn-neutral float-right" title="cpl_query.base package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.query.base.html" class="btn btn-neutral float-right" title="cpl.query.base package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
108
docs/build/html/cpl_query.iterable.html
vendored
108
docs/build/html/cpl_query.iterable.html
vendored
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_query.iterable package — Common Python Library documentation</title>
|
||||
<title>cpl.query.iterable package — Common Python Library documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -20,7 +20,7 @@
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Translation reference" href="cpl_translation.html" />
|
||||
<link rel="prev" title="cpl_query.extension package" href="cpl_query.extension.html" />
|
||||
<link rel="prev" title="cpl.query.extension package" href="cpl.query.extension.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -48,25 +48,25 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_query.html">Query reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html">cpl_query.base package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html">cpl_query.enumerable package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.extension.html">cpl_query.extension package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_query.iterable package</a><ul>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl.query.html">Query reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.base.html">cpl.query.base package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.enumerable.html">cpl.query.enumerable package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.extension.html">cpl.query.extension package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.query.iterable package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.iterable.iterable">cpl_query.iterable.iterable module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.iterable.iterable.Iterable"><code class="docutils literal notranslate"><span class="pre">Iterable</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.query.iterable.iterable">cpl.query.iterable.iterable module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.query.iterable.iterable.Iterable"><code class="docutils literal notranslate"><span class="pre">Iterable</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.iterable.iterable_abc">cpl_query.iterable.iterable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.iterable.iterable_abc.IterableABC"><code class="docutils literal notranslate"><span class="pre">IterableABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.query.iterable.iterable_abc">cpl.query.iterable.iterable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.query.iterable.iterable_abc.IterableABC"><code class="docutils literal notranslate"><span class="pre">IterableABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.iterable">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.query.iterable">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.iterable.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.query.iterable.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -90,10 +90,10 @@
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_query.html">Query reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl_query.iterable package</li>
|
||||
<li class="breadcrumb-item"><a href="cpl.query.html">Query reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl.query.iterable package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_query.iterable.rst.txt" rel="nofollow"> View page source</a>
|
||||
<a href="_sources/cpl.query.iterable.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -102,29 +102,29 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="cpl-query-iterable-package">
|
||||
<h1>cpl_query.iterable package<a class="headerlink" href="#cpl-query-iterable-package" title="Permalink to this heading"></a></h1>
|
||||
<h1>cpl.query.iterable package<a class="headerlink" href="#cpl-query-iterable-package" title="Permalink to this heading"></a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_query.iterable.iterable">
|
||||
<span id="cpl-query-iterable-iterable-module"></span><h2>cpl_query.iterable.iterable module<a class="headerlink" href="#module-cpl_query.iterable.iterable" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.query.iterable.iterable">
|
||||
<span id="cpl-query-iterable-iterable-module"></span><h2>cpl.query.iterable.iterable module<a class="headerlink" href="#module-cpl.query.iterable.iterable" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.iterable.Iterable">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.iterable.iterable.</span></span><span class="sig-name descname"><span class="pre">Iterable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.iterable.iterable.Iterable" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_query.iterable.iterable_abc.IterableABC" title="cpl_query.iterable.iterable_abc.IterableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">IterableABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.query.iterable.iterable.Iterable">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.query.iterable.iterable.</span></span><span class="sig-name descname"><span class="pre">Iterable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.query.iterable.iterable.Iterable" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.query.iterable.iterable_abc.IterableABC" title="cpl.query.iterable.iterable_abc.IterableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">IterableABC</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_query.iterable.iterable_abc">
|
||||
<span id="cpl-query-iterable-iterable-abc-module"></span><h2>cpl_query.iterable.iterable_abc module<a class="headerlink" href="#module-cpl_query.iterable.iterable_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.query.iterable.iterable_abc">
|
||||
<span id="cpl-query-iterable-iterable-abc-module"></span><h2>cpl.query.iterable.iterable_abc module<a class="headerlink" href="#module-cpl.query.iterable.iterable_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.iterable_abc.IterableABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.iterable.iterable_abc.</span></span><span class="sig-name descname"><span class="pre">IterableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.iterable.iterable_abc.IterableABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryableABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.query.iterable.iterable_abc.IterableABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.query.iterable.iterable_abc.</span></span><span class="sig-name descname"><span class="pre">IterableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.query.iterable.iterable_abc.IterableABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC" title="cpl.query.base.queryable_abc.QueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryableABC</span></code></a></p>
|
||||
<p>ABC to define functions on list</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.iterable_abc.IterableABC.add">
|
||||
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_object</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.iterable.iterable_abc.IterableABC.add" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.iterable.iterable_abc.IterableABC.add">
|
||||
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_object</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.query.iterable.iterable_abc.IterableABC.add" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds element to list</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -136,17 +136,17 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.iterable_abc.IterableABC.append">
|
||||
<span class="sig-name descname"><span class="pre">append</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_object</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.iterable.iterable_abc.IterableABC.append" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.iterable.iterable_abc.IterableABC.append">
|
||||
<span class="sig-name descname"><span class="pre">append</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_object</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.query.iterable.iterable_abc.IterableABC.append" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.iterable_abc.IterableABC.extend">
|
||||
<span class="sig-name descname"><span class="pre">extend</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_IterableABC__iterable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.iterable.iterable_abc.IterableABC" title="cpl_query.iterable.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.iterable.iterable_abc.IterableABC.extend" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.iterable.iterable_abc.IterableABC.extend">
|
||||
<span class="sig-name descname"><span class="pre">extend</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_IterableABC__iterable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.query.iterable.iterable_abc.IterableABC" title="cpl.query.iterable.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl.query.iterable.iterable_abc.IterableABC.extend" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds elements of given list to list</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>__iterable: :class: <cite>cpl_query.extension.iterable.Iterable</cite></dt><dd><p>index</p>
|
||||
<dt>__iterable: :class: <cite>cpl.query.extension.iterable.Iterable</cite></dt><dd><p>index</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
@@ -154,8 +154,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.iterable_abc.IterableABC.remove">
|
||||
<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_object</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.iterable.iterable_abc.IterableABC.remove" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.iterable.iterable_abc.IterableABC.remove">
|
||||
<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_object</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.query.iterable.iterable_abc.IterableABC.remove" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Removes element from list</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -167,8 +167,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.iterable_abc.IterableABC.remove_at">
|
||||
<span class="sig-name descname"><span class="pre">remove_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.iterable.iterable_abc.IterableABC.remove_at" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.iterable.iterable_abc.IterableABC.remove_at">
|
||||
<span class="sig-name descname"><span class="pre">remove_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.query.iterable.iterable_abc.IterableABC.remove_at" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Removes element from list</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -180,13 +180,13 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.iterable_abc.IterableABC.to_enumerable">
|
||||
<span class="sig-name descname"><span class="pre">to_enumerable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.enumerable_abc.EnumerableABC" title="cpl_query.enumerable.enumerable_abc.EnumerableABC"><span class="pre">EnumerableABC</span></a></span></span><a class="headerlink" href="#cpl_query.iterable.iterable_abc.IterableABC.to_enumerable" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts :class: <cite>cpl_query.iterable.iterable_abc.IterableABC</cite> to :class: <cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite></p>
|
||||
<dt class="sig sig-object py" id="cpl.query.iterable.iterable_abc.IterableABC.to_enumerable">
|
||||
<span class="sig-name descname"><span class="pre">to_enumerable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl.query.enumerable.html#cpl.query.enumerable.enumerable_abc.EnumerableABC" title="cpl.query.enumerable.enumerable_abc.EnumerableABC"><span class="pre">EnumerableABC</span></a></span></span><a class="headerlink" href="#cpl.query.iterable.iterable_abc.IterableABC.to_enumerable" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts :class: <cite>cpl.query.iterable.iterable_abc.IterableABC</cite> to :class: <cite>cpl.query.enumerable.enumerable_abc.EnumerableABC</cite></p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><dl class="field-list simple">
|
||||
<dt class="field-odd">class<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite></p>
|
||||
<dd class="field-odd"><p><cite>cpl.query.enumerable.enumerable_abc.EnumerableABC</cite></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
@@ -196,8 +196,8 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_query.iterable">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_query.iterable" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.query.iterable">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl.query.iterable" title="Permalink to this heading"></a></h2>
|
||||
<section id="cpl-query-cpl-queries">
|
||||
<h3>cpl-query CPL Queries<a class="headerlink" href="#cpl-query-cpl-queries" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL Python integrated Queries</p>
|
||||
@@ -213,24 +213,24 @@
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.iterable.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.iterable.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.iterable.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.query.iterable.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.query.iterable.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_query.iterable.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.iterable.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl.query.iterable.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_query.iterable.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.iterable.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl.query.iterable.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_query.iterable.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.query.iterable.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl.query.iterable.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
@@ -243,7 +243,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_query.extension.html" class="btn btn-neutral float-left" title="cpl_query.extension package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl.query.extension.html" class="btn btn-neutral float-left" title="cpl.query.extension package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_translation.html" class="btn btn-neutral float-right" title="Translation reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
|
||||
12
docs/build/html/cpl_translation.html
vendored
12
docs/build/html/cpl_translation.html
vendored
@@ -19,7 +19,7 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="prev" title="cpl_query.iterable package" href="cpl_query.iterable.html" />
|
||||
<link rel="prev" title="cpl.query.iterable package" href="cpl.query.iterable.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -47,9 +47,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Translation reference</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_translation.translate_pipe">cpl_translation.translate_pipe</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#cpl_translation.translate_pipe.TranslatePipe"><code class="docutils literal notranslate"><span class="pre">TranslatePipe</span></code></a><ul>
|
||||
@@ -123,7 +123,7 @@
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_translation.translate_pipe.TranslatePipe">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_translation.translate_pipe.</span></span><span class="sig-name descname"><span class="pre">TranslatePipe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">translation</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_translation.translation_service_abc.TranslationServiceABC" title="cpl_translation.translation_service_abc.TranslationServiceABC"><span class="pre">TranslationServiceABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_translation.translate_pipe.TranslatePipe" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.pipe_abc.PipeABC" title="cpl_core.pipes.pipe_abc.PipeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipeABC</span></code></a></p>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.core.pipes.html#cpl.core.pipes.pipe_abc.PipeABC" title="cpl.core.pipes.pipe_abc.PipeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipeABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_translation.translate_pipe.TranslatePipe.transform">
|
||||
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">any</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_translation.translate_pipe.TranslatePipe.transform" title="Permalink to this definition"></a></dt>
|
||||
@@ -205,7 +205,7 @@
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_translation.translation_settings.TranslationSettings">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_translation.translation_settings.</span></span><span class="sig-name descname"><span class="pre">TranslationSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">languages</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_lang</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_translation.translation_settings.TranslationSettings" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_translation.translation_settings.TranslationSettings.default_language">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">default_language</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_translation.translation_settings.TranslationSettings.default_language" title="Permalink to this definition"></a></dt>
|
||||
@@ -225,7 +225,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_query.iterable.html" class="btn btn-neutral float-left" title="cpl_query.iterable package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl.query.iterable.html" class="btn btn-neutral float-left" title="cpl.query.iterable package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
6
docs/build/html/deprecated.html
vendored
6
docs/build/html/deprecated.html
vendored
@@ -52,9 +52,9 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -126,7 +126,7 @@ JSON is processed further. This way nested ConfigurationModels can be processed.
|
||||
<span class="w"> </span>self.micro:<span class="w"> </span>Optional<span class="o">[</span>str<span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>micro<span class="w"> </span><span class="k">if</span><span class="w"> </span>micro<span class="w"> </span>!<span class="o">=</span><span class="w"> </span><span class="s2">""</span><span class="w"> </span><span class="k">else</span><span class="w"> </span>None
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>This makes the <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict"><span class="xref myst py py-meth">from_dict</span></a> function obsolete.</p>
|
||||
<p>This makes the <a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict" title="cpl.core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict"><span class="xref myst py py-meth">from_dict</span></a> function obsolete.</p>
|
||||
<p>A few rules must be observed:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Only simple types can be processed
|
||||
|
||||
1546
docs/build/html/genindex.html
vendored
1546
docs/build/html/genindex.html
vendored
File diff suppressed because it is too large
Load Diff
6
docs/build/html/getting_started.html
vendored
6
docs/build/html/getting_started.html
vendored
@@ -53,9 +53,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -128,7 +128,7 @@
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console-arguments.html#coming-soon">Coming soon</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="tutorials.console.html">Use cpl_core.console.Console</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="tutorials.console.html">Use cpl.core.console.Console</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html#coming-soon">Coming soon</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
8
docs/build/html/index.html
vendored
8
docs/build/html/index.html
vendored
@@ -47,9 +47,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -243,9 +243,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
8
docs/build/html/introduction.html
vendored
8
docs/build/html/introduction.html
vendored
@@ -52,9 +52,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -176,9 +176,9 @@
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="quickstart.html"><span class="doc std std-doc">Getting started</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="setup.html"><span class="doc std std-doc">Setup</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_core.html"><span class="doc std std-doc">API Reference</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl.core.html"><span class="doc std std-doc">API Reference</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_cli.overview.html"><span class="doc std std-doc">CLI Reference</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_query.html"><span class="doc std std-doc">Query Reference</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl.query.html"><span class="doc std std-doc">Query Reference</span></a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
450
docs/build/html/modules.html
vendored
450
docs/build/html/modules.html
vendored
@@ -46,9 +46,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -159,352 +159,352 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.application.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application.application_abc">cpl_core.application.application_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_abc.ApplicationABC"><code class="docutils literal notranslate"><span class="pre">ApplicationABC</span></code></a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.application.html">cpl.core.application package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.application.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.application.html#module-cpl.core.application.application_abc">cpl.core.application.application_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.application.html#cpl.core.application.application_abc.ApplicationABC"><code class="docutils literal notranslate"><span class="pre">ApplicationABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application.application_builder">cpl_core.application.application_builder module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_builder.ApplicationBuilder"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilder</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.application.html#module-cpl.core.application.application_builder">cpl.core.application.application_builder module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.application.html#cpl.core.application.application_builder.ApplicationBuilder"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilder</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application.application_builder_abc">cpl_core.application.application_builder_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_builder_abc.ApplicationBuilderABC"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilderABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.application.html#module-cpl.core.application.application_builder_abc">cpl.core.application.application_builder_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.application.html#cpl.core.application.application_builder_abc.ApplicationBuilderABC"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilderABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application.application_extension_abc">cpl_core.application.application_extension_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_extension_abc.ApplicationExtensionABC"><code class="docutils literal notranslate"><span class="pre">ApplicationExtensionABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.application.html#module-cpl.core.application.application_extension_abc">cpl.core.application.application_extension_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.application.html#cpl.core.application.application_extension_abc.ApplicationExtensionABC"><code class="docutils literal notranslate"><span class="pre">ApplicationExtensionABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application.startup_abc">cpl_core.application.startup_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.startup_abc.StartupABC"><code class="docutils literal notranslate"><span class="pre">StartupABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.application.html#module-cpl.core.application.startup_abc">cpl.core.application.startup_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.application.html#cpl.core.application.startup_abc.StartupABC"><code class="docutils literal notranslate"><span class="pre">StartupABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application.startup_extension_abc">cpl_core.application.startup_extension_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.startup_extension_abc.StartupExtensionABC"><code class="docutils literal notranslate"><span class="pre">StartupExtensionABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.application.html#module-cpl.core.application.startup_extension_abc">cpl.core.application.startup_extension_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.application.html#cpl.core.application.startup_extension_abc.StartupExtensionABC"><code class="docutils literal notranslate"><span class="pre">StartupExtensionABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.application.html#module-cpl.core.application">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.application.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.application.html#cpl.core.application.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.argument_abc">cpl_core.configuration.argument_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.argument_abc.ArgumentABC"><code class="docutils literal notranslate"><span class="pre">ArgumentABC</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.configuration.html">cpl.core.configuration package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.configuration.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.configuration.html#module-cpl.core.configuration.argument_abc">cpl.core.configuration.argument_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.argument_abc.ArgumentABC"><code class="docutils literal notranslate"><span class="pre">ArgumentABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.argument_builder">cpl_core.configuration.argument_builder module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.argument_builder.ArgumentBuilder"><code class="docutils literal notranslate"><span class="pre">ArgumentBuilder</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.configuration.html#module-cpl.core.configuration.argument_builder">cpl.core.configuration.argument_builder module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.argument_builder.ArgumentBuilder"><code class="docutils literal notranslate"><span class="pre">ArgumentBuilder</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.argument_executable_abc">cpl_core.configuration.argument_executable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC"><code class="docutils literal notranslate"><span class="pre">ArgumentExecutableABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.configuration.html#module-cpl.core.configuration.argument_executable_abc">cpl.core.configuration.argument_executable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.argument_executable_abc.ArgumentExecutableABC"><code class="docutils literal notranslate"><span class="pre">ArgumentExecutableABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.argument_type_enum">cpl_core.configuration.argument_type_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum"><code class="docutils literal notranslate"><span class="pre">ArgumentTypeEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.configuration.html#module-cpl.core.configuration.argument_type_enum">cpl.core.configuration.argument_type_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.argument_type_enum.ArgumentTypeEnum"><code class="docutils literal notranslate"><span class="pre">ArgumentTypeEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.configuration">cpl_core.configuration.configuration module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration"><code class="docutils literal notranslate"><span class="pre">Configuration</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.configuration.html#module-cpl.core.configuration.configuration">cpl.core.configuration.configuration module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration.Configuration"><code class="docutils literal notranslate"><span class="pre">Configuration</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.configuration_abc">cpl_core.configuration.configuration_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="docutils literal notranslate"><span class="pre">ConfigurationABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.configuration.html#module-cpl.core.configuration.configuration_abc">cpl.core.configuration.configuration_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_abc.ConfigurationABC"><code class="docutils literal notranslate"><span class="pre">ConfigurationABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.configuration_model_abc">cpl_core.configuration.configuration_model_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.base_func"><code class="docutils literal notranslate"><span class="pre">base_func()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.configuration.html#module-cpl.core.configuration.configuration_model_abc">cpl.core.configuration.configuration_model_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_model_abc.base_func"><code class="docutils literal notranslate"><span class="pre">base_func()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.configuration_variable_name_enum">cpl_core.configuration.configuration_variable_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum"><code class="docutils literal notranslate"><span class="pre">ConfigurationVariableNameEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.configuration.html#module-cpl.core.configuration.configuration_variable_name_enum">cpl.core.configuration.configuration_variable_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum"><code class="docutils literal notranslate"><span class="pre">ConfigurationVariableNameEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.executable_argument">cpl_core.configuration.executable_argument module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.executable_argument.ExecutableArgument"><code class="docutils literal notranslate"><span class="pre">ExecutableArgument</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.configuration.html#module-cpl.core.configuration.executable_argument">cpl.core.configuration.executable_argument module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.executable_argument.ExecutableArgument"><code class="docutils literal notranslate"><span class="pre">ExecutableArgument</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.flag_argument">cpl_core.configuration.flag_argument module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.flag_argument.FlagArgument"><code class="docutils literal notranslate"><span class="pre">FlagArgument</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.configuration.html#module-cpl.core.configuration.flag_argument">cpl.core.configuration.flag_argument module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.flag_argument.FlagArgument"><code class="docutils literal notranslate"><span class="pre">FlagArgument</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.validator_abc">cpl_core.configuration.validator_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.validator_abc.ValidatorABC"><code class="docutils literal notranslate"><span class="pre">ValidatorABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.configuration.html#module-cpl.core.configuration.validator_abc">cpl.core.configuration.validator_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.validator_abc.ValidatorABC"><code class="docutils literal notranslate"><span class="pre">ValidatorABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.variable_argument">cpl_core.configuration.variable_argument module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.variable_argument.VariableArgument"><code class="docutils literal notranslate"><span class="pre">VariableArgument</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.configuration.html#module-cpl.core.configuration.variable_argument">cpl.core.configuration.variable_argument module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.variable_argument.VariableArgument"><code class="docutils literal notranslate"><span class="pre">VariableArgument</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.configuration.html#module-cpl.core.configuration">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.configuration.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.console.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.console.html#module-cpl_core.console.background_color_enum">cpl_core.console.background_color_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.background_color_enum.BackgroundColorEnum"><code class="docutils literal notranslate"><span class="pre">BackgroundColorEnum</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.console.html">cpl.core.console package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.console.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.console.html#module-cpl.core.console.background_color_enum">cpl.core.console.background_color_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.console.html#cpl.core.console.background_color_enum.BackgroundColorEnum"><code class="docutils literal notranslate"><span class="pre">BackgroundColorEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.console.html#module-cpl_core.console.console">cpl_core.console.console module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console"><code class="docutils literal notranslate"><span class="pre">Console</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.console.html#module-cpl.core.console.console">cpl.core.console.console module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.console.html#cpl.core.console.console.Console"><code class="docutils literal notranslate"><span class="pre">Console</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.console.html#module-cpl_core.console.console_call">cpl_core.console.console_call module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console_call.ConsoleCall"><code class="docutils literal notranslate"><span class="pre">ConsoleCall</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.console.html#module-cpl.core.console.console_call">cpl.core.console.console_call module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.console.html#cpl.core.console.console_call.ConsoleCall"><code class="docutils literal notranslate"><span class="pre">ConsoleCall</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.console.html#module-cpl_core.console.foreground_color_enum">cpl_core.console.foreground_color_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.foreground_color_enum.ForegroundColorEnum"><code class="docutils literal notranslate"><span class="pre">ForegroundColorEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.console.html#module-cpl.core.console.foreground_color_enum">cpl.core.console.foreground_color_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.console.html#cpl.core.console.foreground_color_enum.ForegroundColorEnum"><code class="docutils literal notranslate"><span class="pre">ForegroundColorEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.console.html#module-cpl_core.console.spinner_thread">cpl_core.console.spinner_thread module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.spinner_thread.SpinnerThread"><code class="docutils literal notranslate"><span class="pre">SpinnerThread</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.console.html#module-cpl.core.console.spinner_thread">cpl.core.console.spinner_thread module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.console.html#cpl.core.console.spinner_thread.SpinnerThread"><code class="docutils literal notranslate"><span class="pre">SpinnerThread</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.console.html#module-cpl_core.console">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.console.html#module-cpl.core.console">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.console.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.console.html#cpl.core.console.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html">cpl_core.database package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html">cpl_core.database.connection package</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.database.html">cpl.core.database package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.connection.html">cpl.core.database.connection package</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.context.html">cpl.core.database.context package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings">cpl_core.database.database_settings module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings"><code class="docutils literal notranslate"><span class="pre">DatabaseSettings</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.html#module-cpl.core.database.database_settings">cpl.core.database.database_settings module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.html#cpl.core.database.database_settings.DatabaseSettings"><code class="docutils literal notranslate"><span class="pre">DatabaseSettings</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">DatabaseSettingsNameEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.html#module-cpl.core.database.database_settings_name_enum">cpl.core.database.database_settings_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.html#cpl.core.database.database_settings_name_enum.DatabaseSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">DatabaseSettingsNameEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.table_abc">cpl_core.database.table_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.table_abc.TableABC"><code class="docutils literal notranslate"><span class="pre">TableABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.html#module-cpl.core.database.table_abc">cpl.core.database.table_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.html#cpl.core.database.table_abc.TableABC"><code class="docutils literal notranslate"><span class="pre">TableABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.database.html#module-cpl.core.database">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.database.html#cpl.core.database.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.scope">cpl_core.dependency_injection.scope module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.scope.Scope"><code class="docutils literal notranslate"><span class="pre">Scope</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.dependency_injection.html">cpl.core.dependency_injection package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.dependency_injection.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.scope">cpl.core.dependency_injection.scope module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.scope.Scope"><code class="docutils literal notranslate"><span class="pre">Scope</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.scope_abc">cpl_core.dependency_injection.scope_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="docutils literal notranslate"><span class="pre">ScopeABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.scope_abc">cpl.core.dependency_injection.scope_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.scope_abc.ScopeABC"><code class="docutils literal notranslate"><span class="pre">ScopeABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.scope_builder">cpl_core.dependency_injection.scope_builder module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.scope_builder.ScopeBuilder"><code class="docutils literal notranslate"><span class="pre">ScopeBuilder</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.scope_builder">cpl.core.dependency_injection.scope_builder module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.scope_builder.ScopeBuilder"><code class="docutils literal notranslate"><span class="pre">ScopeBuilder</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_collection">cpl_core.dependency_injection.service_collection module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection.ServiceCollection"><code class="docutils literal notranslate"><span class="pre">ServiceCollection</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.service_collection">cpl.core.dependency_injection.service_collection module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.service_collection.ServiceCollection"><code class="docutils literal notranslate"><span class="pre">ServiceCollection</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_collection_abc">cpl_core.dependency_injection.service_collection_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="docutils literal notranslate"><span class="pre">ServiceCollectionABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.service_collection_abc">cpl.core.dependency_injection.service_collection_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="docutils literal notranslate"><span class="pre">ServiceCollectionABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_descriptor">cpl_core.dependency_injection.service_descriptor module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor"><code class="docutils literal notranslate"><span class="pre">ServiceDescriptor</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.service_descriptor">cpl.core.dependency_injection.service_descriptor module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.service_descriptor.ServiceDescriptor"><code class="docutils literal notranslate"><span class="pre">ServiceDescriptor</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_lifetime_enum">cpl_core.dependency_injection.service_lifetime_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><code class="docutils literal notranslate"><span class="pre">ServiceLifetimeEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.service_lifetime_enum">cpl.core.dependency_injection.service_lifetime_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><code class="docutils literal notranslate"><span class="pre">ServiceLifetimeEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_provider">cpl_core.dependency_injection.service_provider module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider.ServiceProvider"><code class="docutils literal notranslate"><span class="pre">ServiceProvider</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.service_provider">cpl.core.dependency_injection.service_provider module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.service_provider.ServiceProvider"><code class="docutils literal notranslate"><span class="pre">ServiceProvider</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_provider_abc">cpl_core.dependency_injection.service_provider_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="docutils literal notranslate"><span class="pre">ServiceProviderABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.service_provider_abc">cpl.core.dependency_injection.service_provider_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="docutils literal notranslate"><span class="pre">ServiceProviderABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.dependency_injection.html#cpl.core.dependency_injection.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.environment.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.environment.html#module-cpl_core.environment.application_environment">cpl_core.environment.application_environment module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment.ApplicationEnvironment"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironment</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.environment.html">cpl.core.environment package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.environment.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.environment.html#module-cpl.core.environment.application_environment">cpl.core.environment.application_environment module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.environment.html#cpl.core.environment.application_environment.ApplicationEnvironment"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironment</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.environment.html#module-cpl_core.environment.application_environment_abc">cpl_core.environment.application_environment_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironmentABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.environment.html#module-cpl.core.environment.application_environment_abc">cpl.core.environment.application_environment_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.environment.html#cpl.core.environment.application_environment_abc.ApplicationEnvironmentABC"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironmentABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.environment.html#module-cpl_core.environment.environment_name_enum">cpl_core.environment.environment_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.environment_name_enum.EnvironmentNameEnum"><code class="docutils literal notranslate"><span class="pre">EnvironmentNameEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.environment.html#module-cpl.core.environment.environment_name_enum">cpl.core.environment.environment_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.environment.html#cpl.core.environment.environment_name_enum.EnvironmentNameEnum"><code class="docutils literal notranslate"><span class="pre">EnvironmentNameEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.environment.html#module-cpl_core.environment">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.environment.html#module-cpl.core.environment">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.environment.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.environment.html#cpl.core.environment.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.log.html">cpl_core.log package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.log.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.log.html#module-cpl_core.log.logger_abc">cpl_core.log.logger_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.log.html#cpl_core.log.logger_abc.LoggerABC"><code class="docutils literal notranslate"><span class="pre">LoggerABC</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.log.html">cpl.core.log package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.log.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.log.html#module-cpl.core.log.logger_abc">cpl.core.log.logger_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.log.html#cpl.core.log.logger_abc.LoggerABC"><code class="docutils literal notranslate"><span class="pre">LoggerABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.log.html#module-cpl_core.log.logger_service">cpl_core.log.logger_service module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.log.html#cpl_core.log.logger_service.Logger"><code class="docutils literal notranslate"><span class="pre">Logger</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.log.html#module-cpl.core.log.logger_service">cpl.core.log.logger_service module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.log.html#cpl.core.log.logger_service.Logger"><code class="docutils literal notranslate"><span class="pre">Logger</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.log.html#module-cpl_core.log.logging_level_enum">cpl_core.log.logging_level_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.log.html#cpl_core.log.logging_level_enum.LoggingLevelEnum"><code class="docutils literal notranslate"><span class="pre">LoggingLevelEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.log.html#module-cpl.core.log.logging_level_enum">cpl.core.log.logging_level_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.log.html#cpl.core.log.logging_level_enum.LoggingLevelEnum"><code class="docutils literal notranslate"><span class="pre">LoggingLevelEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.log.html#module-cpl_core.log.logging_settings">cpl_core.log.logging_settings module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.log.html#cpl_core.log.logging_settings.LoggingSettings"><code class="docutils literal notranslate"><span class="pre">LoggingSettings</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.log.html#module-cpl.core.log.logging_settings">cpl.core.log.logging_settings module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.log.html#cpl.core.log.logging_settings.LoggingSettings"><code class="docutils literal notranslate"><span class="pre">LoggingSettings</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.log.html#module-cpl_core.log.logging_settings_name_enum">cpl_core.log.logging_settings_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.log.html#cpl_core.log.logging_settings_name_enum.LoggingSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">LoggingSettingsNameEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.log.html#module-cpl.core.log.logging_settings_name_enum">cpl.core.log.logging_settings_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.log.html#cpl.core.log.logging_settings_name_enum.LoggingSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">LoggingSettingsNameEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.log.html#module-cpl_core.log">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.log.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.log.html#cpl_core.log.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.log.html#module-cpl.core.log">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.log.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.log.html#cpl.core.log.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_mail.html">cpl_mail package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_mail.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_mail.html#module-cpl_mail.email">cpl_mail.email module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_mail.html#cpl_mail.email.EMail"><code class="docutils literal notranslate"><span class="pre">EMail</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mail.html">cpl.mail package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.mail.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.mail.html#module-cpl.mail.email">cpl.mail.email module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.mail.html#cpl.mail.email.EMail"><code class="docutils literal notranslate"><span class="pre">EMail</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_mail.html#module-cpl_mail.email_client_abc">cpl_mail.email_client_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_mail.html#cpl_mail.email_client_abc.EMailClientABC"><code class="docutils literal notranslate"><span class="pre">EMailClientABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.mail.html#module-cpl.mail.email_client_abc">cpl.mail.email_client_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.mail.html#cpl.mail.email_client_abc.EMailClientABC"><code class="docutils literal notranslate"><span class="pre">EMailClientABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_mail.html#module-cpl_mail.email_client_service">cpl_mail.email_client_service module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_mail.html#cpl_mail.email_client_service.EMailClient"><code class="docutils literal notranslate"><span class="pre">EMailClient</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.mail.html#module-cpl.mail.email_client_service">cpl.mail.email_client_service module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.mail.html#cpl.mail.email_client_service.EMailClient"><code class="docutils literal notranslate"><span class="pre">EMailClient</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_mail.html#module-cpl_mail.email_client_settings">cpl_mail.email_client_settings module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_mail.html#cpl_mail.email_client_settings.EMailClientSettings"><code class="docutils literal notranslate"><span class="pre">EMailClientSettings</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.mail.html#module-cpl.mail.email_client_settings">cpl.mail.email_client_settings module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.mail.html#cpl.mail.email_client_settings.EMailClientSettings"><code class="docutils literal notranslate"><span class="pre">EMailClientSettings</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_mail.html#module-cpl_mail.email_client_settings_name_enum">cpl_mail.email_client_settings_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_mail.html#cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">EMailClientSettingsNameEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.mail.html#module-cpl.mail.email_client_settings_name_enum">cpl.mail.email_client_settings_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.mail.html#cpl.mail.email_client_settings_name_enum.EMailClientSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">EMailClientSettingsNameEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_mail.html#module-cpl_mail">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_mail.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_mail.html#cpl_mail.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.mail.html#module-cpl.mail">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.mail.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.mail.html#cpl.mail.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.bool_pipe">cpl_core.pipes.bool_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.bool_pipe.BoolPipe"><code class="docutils literal notranslate"><span class="pre">BoolPipe</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.pipes.html">cpl.core.pipes package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.pipes.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.pipes.html#module-cpl.core.pipes.bool_pipe">cpl.core.pipes.bool_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.pipes.html#cpl.core.pipes.bool_pipe.BoolPipe"><code class="docutils literal notranslate"><span class="pre">BoolPipe</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.first_char_to_lower_pipe">cpl_core.pipes.first_char_to_lower_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe"><code class="docutils literal notranslate"><span class="pre">FirstCharToLowerPipe</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.pipes.html#module-cpl.core.pipes.first_char_to_lower_pipe">cpl.core.pipes.first_char_to_lower_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.pipes.html#cpl.core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe"><code class="docutils literal notranslate"><span class="pre">FirstCharToLowerPipe</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.first_to_upper_pipe">cpl_core.pipes.first_to_upper_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.first_to_upper_pipe.FirstToUpperPipe"><code class="docutils literal notranslate"><span class="pre">FirstToUpperPipe</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.pipes.html#module-cpl.core.pipes.first_to_upper_pipe">cpl.core.pipes.first_to_upper_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.pipes.html#cpl.core.pipes.first_to_upper_pipe.FirstToUpperPipe"><code class="docutils literal notranslate"><span class="pre">FirstToUpperPipe</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.ip_address_pipe">cpl_core.pipes.ip_address_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.ip_address_pipe.IPAddressPipe"><code class="docutils literal notranslate"><span class="pre">IPAddressPipe</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.pipes.html#module-cpl.core.pipes.ip_address_pipe">cpl.core.pipes.ip_address_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.pipes.html#cpl.core.pipes.ip_address_pipe.IPAddressPipe"><code class="docutils literal notranslate"><span class="pre">IPAddressPipe</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.pipe_abc">cpl_core.pipes.pipe_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.pipe_abc.PipeABC"><code class="docutils literal notranslate"><span class="pre">PipeABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.pipes.html#module-cpl.core.pipes.pipe_abc">cpl.core.pipes.pipe_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.pipes.html#cpl.core.pipes.pipe_abc.PipeABC"><code class="docutils literal notranslate"><span class="pre">PipeABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.to_camel_case_pipe">cpl_core.pipes.to_camel_case_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.to_camel_case_pipe.ToCamelCasePipe"><code class="docutils literal notranslate"><span class="pre">ToCamelCasePipe</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.pipes.html#module-cpl.core.pipes.to_camel_case_pipe">cpl.core.pipes.to_camel_case_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.pipes.html#cpl.core.pipes.to_camel_case_pipe.ToCamelCasePipe"><code class="docutils literal notranslate"><span class="pre">ToCamelCasePipe</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.to_snake_case_pipe">cpl_core.pipes.to_snake_case_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.to_snake_case_pipe.ToSnakeCasePipe"><code class="docutils literal notranslate"><span class="pre">ToSnakeCasePipe</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.pipes.html#module-cpl.core.pipes.to_snake_case_pipe">cpl.core.pipes.to_snake_case_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.pipes.html#cpl.core.pipes.to_snake_case_pipe.ToSnakeCasePipe"><code class="docutils literal notranslate"><span class="pre">ToSnakeCasePipe</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.version_pipe">cpl_core.pipes.version_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.version_pipe.VersionPipe"><code class="docutils literal notranslate"><span class="pre">VersionPipe</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.pipes.html#module-cpl.core.pipes.version_pipe">cpl.core.pipes.version_pipe module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.pipes.html#cpl.core.pipes.version_pipe.VersionPipe"><code class="docutils literal notranslate"><span class="pre">VersionPipe</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.pipes.html#module-cpl.core.pipes">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.pipes.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.pipes.html#cpl.core.pipes.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.time.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.time.html#module-cpl_core.time.time_format_settings">cpl_core.time.time_format_settings module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.time.html#cpl_core.time.time_format_settings.TimeFormatSettings"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettings</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.time.html">cpl.core.time package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.time.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.time.html#module-cpl.core.time.time_format_settings">cpl.core.time.time_format_settings module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.time.html#cpl.core.time.time_format_settings.TimeFormatSettings"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettings</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.time.html#module-cpl_core.time.time_format_settings_names_enum">cpl_core.time.time_format_settings_names_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.time.html#cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettingsNamesEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.time.html#module-cpl.core.time.time_format_settings_names_enum">cpl.core.time.time_format_settings_names_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.time.html#cpl.core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettingsNamesEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.time.html#module-cpl_core.time">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.time.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.time.html#cpl_core.time.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.time.html#module-cpl.core.time">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.time.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.time.html#cpl.core.time.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.utils.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.utils.html#module-cpl_core.utils.credential_manager">cpl_core.utils.credential_manager module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.credential_manager.CredentialManager"><code class="docutils literal notranslate"><span class="pre">CredentialManager</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.utils.html">cpl.core.utils package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.utils.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.utils.html#module-cpl.core.utils.credential_manager">cpl.core.utils.credential_manager module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.utils.html#cpl.core.utils.credential_manager.CredentialManager"><code class="docutils literal notranslate"><span class="pre">CredentialManager</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.utils.html#module-cpl_core.utils.pip">cpl_core.utils.pip module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.pip.Pip"><code class="docutils literal notranslate"><span class="pre">Pip</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.utils.html#module-cpl.core.utils.pip">cpl.core.utils.pip module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.utils.html#cpl.core.utils.pip.Pip"><code class="docutils literal notranslate"><span class="pre">Pip</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.utils.html#module-cpl_core.utils.string">cpl_core.utils.string module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.string.String"><code class="docutils literal notranslate"><span class="pre">String</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.utils.html#module-cpl.core.utils.string">cpl.core.utils.string module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.utils.html#cpl.core.utils.string.String"><code class="docutils literal notranslate"><span class="pre">String</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.utils.html#module-cpl_core.utils">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.core.utils.html#module-cpl.core.utils">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.utils.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.core.utils.html#cpl.core.utils.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -923,79 +923,79 @@
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html">cpl_query.base package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.default_lambda">cpl_query.base.default_lambda module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.default_lambda.default_lambda"><code class="docutils literal notranslate"><span class="pre">default_lambda()</span></code></a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.base.html">cpl.query.base package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.base.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.base.html#module-cpl.query.base.default_lambda">cpl.query.base.default_lambda module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.default_lambda.default_lambda"><code class="docutils literal notranslate"><span class="pre">default_lambda()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.ordered_queryable">cpl_query.base.ordered_queryable module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.ordered_queryable.OrderedQueryable"><code class="docutils literal notranslate"><span class="pre">OrderedQueryable</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.base.html#module-cpl.query.base.ordered_queryable">cpl.query.base.ordered_queryable module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.ordered_queryable.OrderedQueryable"><code class="docutils literal notranslate"><span class="pre">OrderedQueryable</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.ordered_queryable_abc">cpl_query.base.ordered_queryable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="docutils literal notranslate"><span class="pre">OrderedQueryableABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.base.html#module-cpl.query.base.ordered_queryable_abc">cpl.query.base.ordered_queryable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="docutils literal notranslate"><span class="pre">OrderedQueryableABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.queryable_abc">cpl_query.base.queryable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC"><code class="docutils literal notranslate"><span class="pre">QueryableABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.base.html#module-cpl.query.base.queryable_abc">cpl.query.base.queryable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC"><code class="docutils literal notranslate"><span class="pre">QueryableABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.sequence">cpl_query.base.sequence module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.sequence.Sequence"><code class="docutils literal notranslate"><span class="pre">Sequence</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.base.html#module-cpl.query.base.sequence">cpl.query.base.sequence module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.sequence.Sequence"><code class="docutils literal notranslate"><span class="pre">Sequence</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.base.html#module-cpl.query.base">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.base.html#cpl.query.base.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html">cpl_query.enumerable package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.enumerable.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.enumerable.html#module-cpl_query.enumerable.enumerable">cpl_query.enumerable.enumerable module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.enumerable.Enumerable"><code class="docutils literal notranslate"><span class="pre">Enumerable</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.enumerable.html">cpl.query.enumerable package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.enumerable.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.enumerable.html#module-cpl.query.enumerable.enumerable">cpl.query.enumerable.enumerable module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.enumerable.html#cpl.query.enumerable.enumerable.Enumerable"><code class="docutils literal notranslate"><span class="pre">Enumerable</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.enumerable.html#module-cpl_query.enumerable.enumerable_abc">cpl_query.enumerable.enumerable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.enumerable_abc.EnumerableABC"><code class="docutils literal notranslate"><span class="pre">EnumerableABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.enumerable.html#module-cpl.query.enumerable.enumerable_abc">cpl.query.enumerable.enumerable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.enumerable.html#cpl.query.enumerable.enumerable_abc.EnumerableABC"><code class="docutils literal notranslate"><span class="pre">EnumerableABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.enumerable.html#module-cpl_query.enumerable">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.enumerable.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.enumerable.html#module-cpl.query.enumerable">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.enumerable.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.enumerable.html#cpl.query.enumerable.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.extension.html">cpl_query.extension package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.extension.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.extension.html#module-cpl_query.extension.list">cpl_query.extension.list module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.list.List"><code class="docutils literal notranslate"><span class="pre">List</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.extension.html">cpl.query.extension package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.extension.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.extension.html#module-cpl.query.extension.list">cpl.query.extension.list module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.extension.html#cpl.query.extension.list.List"><code class="docutils literal notranslate"><span class="pre">List</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.extension.html#module-cpl_query.extension">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.extension.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.extension.html#module-cpl.query.extension">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.extension.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.extension.html#cpl.query.extension.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.iterable.html">cpl_query.iterable package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.iterable.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.iterable.html#module-cpl_query.iterable.iterable">cpl_query.iterable.iterable module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable.Iterable"><code class="docutils literal notranslate"><span class="pre">Iterable</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.query.iterable.html">cpl.query.iterable package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.iterable.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.iterable.html#module-cpl.query.iterable.iterable">cpl.query.iterable.iterable module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.iterable.html#cpl.query.iterable.iterable.Iterable"><code class="docutils literal notranslate"><span class="pre">Iterable</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.iterable.html#module-cpl_query.iterable.iterable_abc">cpl_query.iterable.iterable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable_abc.IterableABC"><code class="docutils literal notranslate"><span class="pre">IterableABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.iterable.html#module-cpl.query.iterable.iterable_abc">cpl.query.iterable.iterable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.iterable.html#cpl.query.iterable.iterable_abc.IterableABC"><code class="docutils literal notranslate"><span class="pre">IterableABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_query.iterable.html#module-cpl_query.iterable">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl.query.iterable.html#module-cpl.query.iterable">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.iterable.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl.query.iterable.html#cpl.query.iterable.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
192
docs/build/html/py-modindex.html
vendored
192
docs/build/html/py-modindex.html
vendored
@@ -48,9 +48,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -92,397 +92,397 @@
|
||||
<td><img src="_static/minus.png" class="toggler"
|
||||
id="toggle-1" style="display: none" alt="-" /></td>
|
||||
<td>
|
||||
<code class="xref">cpl_core</code></td><td>
|
||||
<code class="xref">cpl.core</code></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.application.html#module-cpl_core.application"><code class="xref">cpl_core.application</code></a></td><td>
|
||||
<a href="cpl.core.application.html#module-cpl.core.application"><code class="xref">cpl.core.application</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.application.html#module-cpl_core.application.application_abc"><code class="xref">cpl_core.application.application_abc</code></a></td><td>
|
||||
<a href="cpl.core.application.html#module-cpl.core.application.application_abc"><code class="xref">cpl.core.application.application_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.application.html#module-cpl_core.application.application_builder"><code class="xref">cpl_core.application.application_builder</code></a></td><td>
|
||||
<a href="cpl.core.application.html#module-cpl.core.application.application_builder"><code class="xref">cpl.core.application.application_builder</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.application.html#module-cpl_core.application.application_builder_abc"><code class="xref">cpl_core.application.application_builder_abc</code></a></td><td>
|
||||
<a href="cpl.core.application.html#module-cpl.core.application.application_builder_abc"><code class="xref">cpl.core.application.application_builder_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.application.html#module-cpl_core.application.application_extension_abc"><code class="xref">cpl_core.application.application_extension_abc</code></a></td><td>
|
||||
<a href="cpl.core.application.html#module-cpl.core.application.application_extension_abc"><code class="xref">cpl.core.application.application_extension_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.application.html#module-cpl_core.application.startup_abc"><code class="xref">cpl_core.application.startup_abc</code></a></td><td>
|
||||
<a href="cpl.core.application.html#module-cpl.core.application.startup_abc"><code class="xref">cpl.core.application.startup_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.application.html#module-cpl_core.application.startup_extension_abc"><code class="xref">cpl_core.application.startup_extension_abc</code></a></td><td>
|
||||
<a href="cpl.core.application.html#module-cpl.core.application.startup_extension_abc"><code class="xref">cpl.core.application.startup_extension_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.configuration.html#module-cpl_core.configuration"><code class="xref">cpl_core.configuration</code></a></td><td>
|
||||
<a href="cpl.core.configuration.html#module-cpl.core.configuration"><code class="xref">cpl.core.configuration</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.configuration.html#module-cpl_core.configuration.argument_abc"><code class="xref">cpl_core.configuration.argument_abc</code></a></td><td>
|
||||
<a href="cpl.core.configuration.html#module-cpl.core.configuration.argument_abc"><code class="xref">cpl.core.configuration.argument_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.configuration.html#module-cpl_core.configuration.argument_builder"><code class="xref">cpl_core.configuration.argument_builder</code></a></td><td>
|
||||
<a href="cpl.core.configuration.html#module-cpl.core.configuration.argument_builder"><code class="xref">cpl.core.configuration.argument_builder</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.configuration.html#module-cpl_core.configuration.argument_executable_abc"><code class="xref">cpl_core.configuration.argument_executable_abc</code></a></td><td>
|
||||
<a href="cpl.core.configuration.html#module-cpl.core.configuration.argument_executable_abc"><code class="xref">cpl.core.configuration.argument_executable_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.configuration.html#module-cpl_core.configuration.argument_type_enum"><code class="xref">cpl_core.configuration.argument_type_enum</code></a></td><td>
|
||||
<a href="cpl.core.configuration.html#module-cpl.core.configuration.argument_type_enum"><code class="xref">cpl.core.configuration.argument_type_enum</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.configuration.html#module-cpl_core.configuration.configuration"><code class="xref">cpl_core.configuration.configuration</code></a></td><td>
|
||||
<a href="cpl.core.configuration.html#module-cpl.core.configuration.configuration"><code class="xref">cpl.core.configuration.configuration</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.configuration.html#module-cpl_core.configuration.configuration_abc"><code class="xref">cpl_core.configuration.configuration_abc</code></a></td><td>
|
||||
<a href="cpl.core.configuration.html#module-cpl.core.configuration.configuration_abc"><code class="xref">cpl.core.configuration.configuration_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.configuration.html#module-cpl_core.configuration.configuration_model_abc"><code class="xref">cpl_core.configuration.configuration_model_abc</code></a></td><td>
|
||||
<a href="cpl.core.configuration.html#module-cpl.core.configuration.configuration_model_abc"><code class="xref">cpl.core.configuration.configuration_model_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.configuration.html#module-cpl_core.configuration.configuration_variable_name_enum"><code class="xref">cpl_core.configuration.configuration_variable_name_enum</code></a></td><td>
|
||||
<a href="cpl.core.configuration.html#module-cpl.core.configuration.configuration_variable_name_enum"><code class="xref">cpl.core.configuration.configuration_variable_name_enum</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.configuration.html#module-cpl_core.configuration.executable_argument"><code class="xref">cpl_core.configuration.executable_argument</code></a></td><td>
|
||||
<a href="cpl.core.configuration.html#module-cpl.core.configuration.executable_argument"><code class="xref">cpl.core.configuration.executable_argument</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.configuration.html#module-cpl_core.configuration.flag_argument"><code class="xref">cpl_core.configuration.flag_argument</code></a></td><td>
|
||||
<a href="cpl.core.configuration.html#module-cpl.core.configuration.flag_argument"><code class="xref">cpl.core.configuration.flag_argument</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.configuration.html#module-cpl_core.configuration.validator_abc"><code class="xref">cpl_core.configuration.validator_abc</code></a></td><td>
|
||||
<a href="cpl.core.configuration.html#module-cpl.core.configuration.validator_abc"><code class="xref">cpl.core.configuration.validator_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.configuration.html#module-cpl_core.configuration.variable_argument"><code class="xref">cpl_core.configuration.variable_argument</code></a></td><td>
|
||||
<a href="cpl.core.configuration.html#module-cpl.core.configuration.variable_argument"><code class="xref">cpl.core.configuration.variable_argument</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.console.html#module-cpl_core.console"><code class="xref">cpl_core.console</code></a></td><td>
|
||||
<a href="cpl.core.console.html#module-cpl.core.console"><code class="xref">cpl.core.console</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.console.html#module-cpl_core.console.background_color_enum"><code class="xref">cpl_core.console.background_color_enum</code></a></td><td>
|
||||
<a href="cpl.core.console.html#module-cpl.core.console.background_color_enum"><code class="xref">cpl.core.console.background_color_enum</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.console.html#module-cpl_core.console.console"><code class="xref">cpl_core.console.console</code></a></td><td>
|
||||
<a href="cpl.core.console.html#module-cpl.core.console.console"><code class="xref">cpl.core.console.console</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.console.html#module-cpl_core.console.console_call"><code class="xref">cpl_core.console.console_call</code></a></td><td>
|
||||
<a href="cpl.core.console.html#module-cpl.core.console.console_call"><code class="xref">cpl.core.console.console_call</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.console.html#module-cpl_core.console.foreground_color_enum"><code class="xref">cpl_core.console.foreground_color_enum</code></a></td><td>
|
||||
<a href="cpl.core.console.html#module-cpl.core.console.foreground_color_enum"><code class="xref">cpl.core.console.foreground_color_enum</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.console.html#module-cpl_core.console.spinner_thread"><code class="xref">cpl_core.console.spinner_thread</code></a></td><td>
|
||||
<a href="cpl.core.console.html#module-cpl.core.console.spinner_thread"><code class="xref">cpl.core.console.spinner_thread</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.database.html#module-cpl_core.database"><code class="xref">cpl_core.database</code></a></td><td>
|
||||
<a href="cpl.core.database.html#module-cpl.core.database"><code class="xref">cpl.core.database</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.database.connection.html#module-cpl_core.database.connection"><code class="xref">cpl_core.database.connection</code></a></td><td>
|
||||
<a href="cpl.core.database.connection.html#module-cpl.core.database.connection"><code class="xref">cpl.core.database.connection</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.database.connection.html#module-cpl_core.database.connection.database_connection"><code class="xref">cpl_core.database.connection.database_connection</code></a></td><td>
|
||||
<a href="cpl.core.database.connection.html#module-cpl.core.database.connection.database_connection"><code class="xref">cpl.core.database.connection.database_connection</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.database.connection.html#module-cpl_core.database.connection.database_connection_abc"><code class="xref">cpl_core.database.connection.database_connection_abc</code></a></td><td>
|
||||
<a href="cpl.core.database.connection.html#module-cpl.core.database.connection.database_connection_abc"><code class="xref">cpl.core.database.connection.database_connection_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.database.context.html#module-cpl_core.database.context"><code class="xref">cpl_core.database.context</code></a></td><td>
|
||||
<a href="cpl.core.database.context.html#module-cpl.core.database.context"><code class="xref">cpl.core.database.context</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.database.context.html#module-cpl_core.database.context.database_context"><code class="xref">cpl_core.database.context.database_context</code></a></td><td>
|
||||
<a href="cpl.core.database.context.html#module-cpl.core.database.context.database_context"><code class="xref">cpl.core.database.context.database_context</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.database.context.html#module-cpl_core.database.context.database_context_abc"><code class="xref">cpl_core.database.context.database_context_abc</code></a></td><td>
|
||||
<a href="cpl.core.database.context.html#module-cpl.core.database.context.database_context_abc"><code class="xref">cpl.core.database.context.database_context_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.database.html#module-cpl_core.database.database_settings"><code class="xref">cpl_core.database.database_settings</code></a></td><td>
|
||||
<a href="cpl.core.database.html#module-cpl.core.database.database_settings"><code class="xref">cpl.core.database.database_settings</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.database.html#module-cpl_core.database.database_settings_name_enum"><code class="xref">cpl_core.database.database_settings_name_enum</code></a></td><td>
|
||||
<a href="cpl.core.database.html#module-cpl.core.database.database_settings_name_enum"><code class="xref">cpl.core.database.database_settings_name_enum</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.database.html#module-cpl_core.database.table_abc"><code class="xref">cpl_core.database.table_abc</code></a></td><td>
|
||||
<a href="cpl.core.database.html#module-cpl.core.database.table_abc"><code class="xref">cpl.core.database.table_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection"><code class="xref">cpl_core.dependency_injection</code></a></td><td>
|
||||
<a href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection"><code class="xref">cpl.core.dependency_injection</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.scope"><code class="xref">cpl_core.dependency_injection.scope</code></a></td><td>
|
||||
<a href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.scope"><code class="xref">cpl.core.dependency_injection.scope</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.scope_abc"><code class="xref">cpl_core.dependency_injection.scope_abc</code></a></td><td>
|
||||
<a href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.scope_abc"><code class="xref">cpl.core.dependency_injection.scope_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.scope_builder"><code class="xref">cpl_core.dependency_injection.scope_builder</code></a></td><td>
|
||||
<a href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.scope_builder"><code class="xref">cpl.core.dependency_injection.scope_builder</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_collection"><code class="xref">cpl_core.dependency_injection.service_collection</code></a></td><td>
|
||||
<a href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.service_collection"><code class="xref">cpl.core.dependency_injection.service_collection</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_collection_abc"><code class="xref">cpl_core.dependency_injection.service_collection_abc</code></a></td><td>
|
||||
<a href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.service_collection_abc"><code class="xref">cpl.core.dependency_injection.service_collection_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_descriptor"><code class="xref">cpl_core.dependency_injection.service_descriptor</code></a></td><td>
|
||||
<a href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.service_descriptor"><code class="xref">cpl.core.dependency_injection.service_descriptor</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_lifetime_enum"><code class="xref">cpl_core.dependency_injection.service_lifetime_enum</code></a></td><td>
|
||||
<a href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.service_lifetime_enum"><code class="xref">cpl.core.dependency_injection.service_lifetime_enum</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_provider"><code class="xref">cpl_core.dependency_injection.service_provider</code></a></td><td>
|
||||
<a href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.service_provider"><code class="xref">cpl.core.dependency_injection.service_provider</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_provider_abc"><code class="xref">cpl_core.dependency_injection.service_provider_abc</code></a></td><td>
|
||||
<a href="cpl.core.dependency_injection.html#module-cpl.core.dependency_injection.service_provider_abc"><code class="xref">cpl.core.dependency_injection.service_provider_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.environment.html#module-cpl_core.environment"><code class="xref">cpl_core.environment</code></a></td><td>
|
||||
<a href="cpl.core.environment.html#module-cpl.core.environment"><code class="xref">cpl.core.environment</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.environment.html#module-cpl_core.environment.application_environment"><code class="xref">cpl_core.environment.application_environment</code></a></td><td>
|
||||
<a href="cpl.core.environment.html#module-cpl.core.environment.application_environment"><code class="xref">cpl.core.environment.application_environment</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.environment.html#module-cpl_core.environment.application_environment_abc"><code class="xref">cpl_core.environment.application_environment_abc</code></a></td><td>
|
||||
<a href="cpl.core.environment.html#module-cpl.core.environment.application_environment_abc"><code class="xref">cpl.core.environment.application_environment_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.environment.html#module-cpl_core.environment.environment_name_enum"><code class="xref">cpl_core.environment.environment_name_enum</code></a></td><td>
|
||||
<a href="cpl.core.environment.html#module-cpl.core.environment.environment_name_enum"><code class="xref">cpl.core.environment.environment_name_enum</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.log.html#module-cpl_core.log"><code class="xref">cpl_core.log</code></a></td><td>
|
||||
<a href="cpl.core.log.html#module-cpl.core.log"><code class="xref">cpl.core.log</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.log.html#module-cpl_core.log.logger_abc"><code class="xref">cpl_core.log.logger_abc</code></a></td><td>
|
||||
<a href="cpl.core.log.html#module-cpl.core.log.logger_abc"><code class="xref">cpl.core.log.logger_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.log.html#module-cpl_core.log.logger_service"><code class="xref">cpl_core.log.logger_service</code></a></td><td>
|
||||
<a href="cpl.core.log.html#module-cpl.core.log.logger_service"><code class="xref">cpl.core.log.logger_service</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.log.html#module-cpl_core.log.logging_level_enum"><code class="xref">cpl_core.log.logging_level_enum</code></a></td><td>
|
||||
<a href="cpl.core.log.html#module-cpl.core.log.logging_level_enum"><code class="xref">cpl.core.log.logging_level_enum</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.log.html#module-cpl_core.log.logging_settings"><code class="xref">cpl_core.log.logging_settings</code></a></td><td>
|
||||
<a href="cpl.core.log.html#module-cpl.core.log.logging_settings"><code class="xref">cpl.core.log.logging_settings</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.log.html#module-cpl_core.log.logging_settings_name_enum"><code class="xref">cpl_core.log.logging_settings_name_enum</code></a></td><td>
|
||||
<a href="cpl.core.log.html#module-cpl.core.log.logging_settings_name_enum"><code class="xref">cpl.core.log.logging_settings_name_enum</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_mail.html#module-cpl_mail"><code class="xref">cpl_mail</code></a></td><td>
|
||||
<a href="cpl.mail.html#module-cpl.mail"><code class="xref">cpl.mail</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_mail.html#module-cpl_mail.email"><code class="xref">cpl_mail.email</code></a></td><td>
|
||||
<a href="cpl.mail.html#module-cpl.mail.email"><code class="xref">cpl.mail.email</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_mail.html#module-cpl_mail.email_client_abc"><code class="xref">cpl_mail.email_client_abc</code></a></td><td>
|
||||
<a href="cpl.mail.html#module-cpl.mail.email_client_abc"><code class="xref">cpl.mail.email_client_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_mail.html#module-cpl_mail.email_client_service"><code class="xref">cpl_mail.email_client_service</code></a></td><td>
|
||||
<a href="cpl.mail.html#module-cpl.mail.email_client_service"><code class="xref">cpl.mail.email_client_service</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_mail.html#module-cpl_mail.email_client_settings"><code class="xref">cpl_mail.email_client_settings</code></a></td><td>
|
||||
<a href="cpl.mail.html#module-cpl.mail.email_client_settings"><code class="xref">cpl.mail.email_client_settings</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_mail.html#module-cpl_mail.email_client_settings_name_enum"><code class="xref">cpl_mail.email_client_settings_name_enum</code></a></td><td>
|
||||
<a href="cpl.mail.html#module-cpl.mail.email_client_settings_name_enum"><code class="xref">cpl.mail.email_client_settings_name_enum</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.pipes.html#module-cpl_core.pipes"><code class="xref">cpl_core.pipes</code></a></td><td>
|
||||
<a href="cpl.core.pipes.html#module-cpl.core.pipes"><code class="xref">cpl.core.pipes</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.pipes.html#module-cpl_core.pipes.bool_pipe"><code class="xref">cpl_core.pipes.bool_pipe</code></a></td><td>
|
||||
<a href="cpl.core.pipes.html#module-cpl.core.pipes.bool_pipe"><code class="xref">cpl.core.pipes.bool_pipe</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.pipes.html#module-cpl_core.pipes.first_char_to_lower_pipe"><code class="xref">cpl_core.pipes.first_char_to_lower_pipe</code></a></td><td>
|
||||
<a href="cpl.core.pipes.html#module-cpl.core.pipes.first_char_to_lower_pipe"><code class="xref">cpl.core.pipes.first_char_to_lower_pipe</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.pipes.html#module-cpl_core.pipes.first_to_upper_pipe"><code class="xref">cpl_core.pipes.first_to_upper_pipe</code></a></td><td>
|
||||
<a href="cpl.core.pipes.html#module-cpl.core.pipes.first_to_upper_pipe"><code class="xref">cpl.core.pipes.first_to_upper_pipe</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.pipes.html#module-cpl_core.pipes.ip_address_pipe"><code class="xref">cpl_core.pipes.ip_address_pipe</code></a></td><td>
|
||||
<a href="cpl.core.pipes.html#module-cpl.core.pipes.ip_address_pipe"><code class="xref">cpl.core.pipes.ip_address_pipe</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.pipes.html#module-cpl_core.pipes.pipe_abc"><code class="xref">cpl_core.pipes.pipe_abc</code></a></td><td>
|
||||
<a href="cpl.core.pipes.html#module-cpl.core.pipes.pipe_abc"><code class="xref">cpl.core.pipes.pipe_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.pipes.html#module-cpl_core.pipes.to_camel_case_pipe"><code class="xref">cpl_core.pipes.to_camel_case_pipe</code></a></td><td>
|
||||
<a href="cpl.core.pipes.html#module-cpl.core.pipes.to_camel_case_pipe"><code class="xref">cpl.core.pipes.to_camel_case_pipe</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.pipes.html#module-cpl_core.pipes.to_snake_case_pipe"><code class="xref">cpl_core.pipes.to_snake_case_pipe</code></a></td><td>
|
||||
<a href="cpl.core.pipes.html#module-cpl.core.pipes.to_snake_case_pipe"><code class="xref">cpl.core.pipes.to_snake_case_pipe</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.pipes.html#module-cpl_core.pipes.version_pipe"><code class="xref">cpl_core.pipes.version_pipe</code></a></td><td>
|
||||
<a href="cpl.core.pipes.html#module-cpl.core.pipes.version_pipe"><code class="xref">cpl.core.pipes.version_pipe</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.time.html#module-cpl_core.time"><code class="xref">cpl_core.time</code></a></td><td>
|
||||
<a href="cpl.core.time.html#module-cpl.core.time"><code class="xref">cpl.core.time</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.time.html#module-cpl_core.time.time_format_settings"><code class="xref">cpl_core.time.time_format_settings</code></a></td><td>
|
||||
<a href="cpl.core.time.html#module-cpl.core.time.time_format_settings"><code class="xref">cpl.core.time.time_format_settings</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.time.html#module-cpl_core.time.time_format_settings_names_enum"><code class="xref">cpl_core.time.time_format_settings_names_enum</code></a></td><td>
|
||||
<a href="cpl.core.time.html#module-cpl.core.time.time_format_settings_names_enum"><code class="xref">cpl.core.time.time_format_settings_names_enum</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.utils.html#module-cpl_core.utils"><code class="xref">cpl_core.utils</code></a></td><td>
|
||||
<a href="cpl.core.utils.html#module-cpl.core.utils"><code class="xref">cpl.core.utils</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.utils.html#module-cpl_core.utils.credential_manager"><code class="xref">cpl_core.utils.credential_manager</code></a></td><td>
|
||||
<a href="cpl.core.utils.html#module-cpl.core.utils.credential_manager"><code class="xref">cpl.core.utils.credential_manager</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.utils.html#module-cpl_core.utils.pip"><code class="xref">cpl_core.utils.pip</code></a></td><td>
|
||||
<a href="cpl.core.utils.html#module-cpl.core.utils.pip"><code class="xref">cpl.core.utils.pip</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_core.utils.html#module-cpl_core.utils.string"><code class="xref">cpl_core.utils.string</code></a></td><td>
|
||||
<a href="cpl.core.utils.html#module-cpl.core.utils.string"><code class="xref">cpl.core.utils.string</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr>
|
||||
<td><img src="_static/minus.png" class="toggler"
|
||||
@@ -889,77 +889,77 @@
|
||||
<td><img src="_static/minus.png" class="toggler"
|
||||
id="toggle-3" style="display: none" alt="-" /></td>
|
||||
<td>
|
||||
<code class="xref">cpl_query</code></td><td>
|
||||
<code class="xref">cpl.query</code></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-3">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_query.base.html#module-cpl_query.base"><code class="xref">cpl_query.base</code></a></td><td>
|
||||
<a href="cpl.query.base.html#module-cpl.query.base"><code class="xref">cpl.query.base</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-3">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_query.base.html#module-cpl_query.base.default_lambda"><code class="xref">cpl_query.base.default_lambda</code></a></td><td>
|
||||
<a href="cpl.query.base.html#module-cpl.query.base.default_lambda"><code class="xref">cpl.query.base.default_lambda</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-3">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_query.base.html#module-cpl_query.base.ordered_queryable"><code class="xref">cpl_query.base.ordered_queryable</code></a></td><td>
|
||||
<a href="cpl.query.base.html#module-cpl.query.base.ordered_queryable"><code class="xref">cpl.query.base.ordered_queryable</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-3">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_query.base.html#module-cpl_query.base.ordered_queryable_abc"><code class="xref">cpl_query.base.ordered_queryable_abc</code></a></td><td>
|
||||
<a href="cpl.query.base.html#module-cpl.query.base.ordered_queryable_abc"><code class="xref">cpl.query.base.ordered_queryable_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-3">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_query.base.html#module-cpl_query.base.queryable_abc"><code class="xref">cpl_query.base.queryable_abc</code></a></td><td>
|
||||
<a href="cpl.query.base.html#module-cpl.query.base.queryable_abc"><code class="xref">cpl.query.base.queryable_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-3">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_query.base.html#module-cpl_query.base.sequence"><code class="xref">cpl_query.base.sequence</code></a></td><td>
|
||||
<a href="cpl.query.base.html#module-cpl.query.base.sequence"><code class="xref">cpl.query.base.sequence</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-3">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_query.enumerable.html#module-cpl_query.enumerable"><code class="xref">cpl_query.enumerable</code></a></td><td>
|
||||
<a href="cpl.query.enumerable.html#module-cpl.query.enumerable"><code class="xref">cpl.query.enumerable</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-3">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_query.enumerable.html#module-cpl_query.enumerable.enumerable"><code class="xref">cpl_query.enumerable.enumerable</code></a></td><td>
|
||||
<a href="cpl.query.enumerable.html#module-cpl.query.enumerable.enumerable"><code class="xref">cpl.query.enumerable.enumerable</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-3">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_query.enumerable.html#module-cpl_query.enumerable.enumerable_abc"><code class="xref">cpl_query.enumerable.enumerable_abc</code></a></td><td>
|
||||
<a href="cpl.query.enumerable.html#module-cpl.query.enumerable.enumerable_abc"><code class="xref">cpl.query.enumerable.enumerable_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-3">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_query.extension.html#module-cpl_query.extension"><code class="xref">cpl_query.extension</code></a></td><td>
|
||||
<a href="cpl.query.extension.html#module-cpl.query.extension"><code class="xref">cpl.query.extension</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-3">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_query.extension.html#module-cpl_query.extension.list"><code class="xref">cpl_query.extension.list</code></a></td><td>
|
||||
<a href="cpl.query.extension.html#module-cpl.query.extension.list"><code class="xref">cpl.query.extension.list</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-3">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_query.iterable.html#module-cpl_query.iterable"><code class="xref">cpl_query.iterable</code></a></td><td>
|
||||
<a href="cpl.query.iterable.html#module-cpl.query.iterable"><code class="xref">cpl.query.iterable</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-3">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_query.iterable.html#module-cpl_query.iterable.iterable"><code class="xref">cpl_query.iterable.iterable</code></a></td><td>
|
||||
<a href="cpl.query.iterable.html#module-cpl.query.iterable.iterable"><code class="xref">cpl.query.iterable.iterable</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-3">
|
||||
<td></td>
|
||||
<td>   
|
||||
<a href="cpl_query.iterable.html#module-cpl_query.iterable.iterable_abc"><code class="xref">cpl_query.iterable.iterable_abc</code></a></td><td>
|
||||
<a href="cpl.query.iterable.html#module-cpl.query.iterable.iterable_abc"><code class="xref">cpl.query.iterable.iterable_abc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr>
|
||||
<td><img src="_static/minus.png" class="toggler"
|
||||
|
||||
14
docs/build/html/quickstart.html
vendored
14
docs/build/html/quickstart.html
vendored
@@ -60,9 +60,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -167,7 +167,7 @@ Creating<span class="w"> </span>sample-project/src/sample-projectmain.py<span cl
|
||||
<li><p>Open the ‘sample-project/main.py’</p></li>
|
||||
<li><p>Change ‘Hello World’ to ‘Password generator:’ in line 5</p></li>
|
||||
<li><p>Add <code class="docutils literal notranslate"><span class="pre">Console.select</span></code> as follows:</p>
|
||||
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">cpl_core.console</span> <span class="kn">import</span> <span class="n">Console</span>
|
||||
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">cpl.core.console</span> <span class="kn">import</span> <span class="n">Console</span>
|
||||
|
||||
|
||||
<span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
|
||||
@@ -232,7 +232,7 @@ Creating<span class="w"> </span>sample-project/src/sample-projectmain.py<span cl
|
||||
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">random</span>
|
||||
<span class="kn">import</span> <span class="nn">string</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">cpl_core.console</span> <span class="kn">import</span> <span class="n">Console</span>
|
||||
<span class="kn">from</span> <span class="nn">cpl.core.console</span> <span class="kn">import</span> <span class="n">Console</span>
|
||||
|
||||
|
||||
<span class="k">def</span> <span class="nf">generate_password</span><span class="p">(</span><span class="n">letters</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">length</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
@@ -278,9 +278,9 @@ Creating<span class="w"> </span>sample-project/src/sample-projectmain.py<span cl
|
||||
<p>In this section, you’ve created an application that uses user input to generate a password.</p>
|
||||
<p>To continue exploring CPL and developing applications:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="cpl_core.application.html"><span class="doc std std-doc">Application base</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_core.dependency_injection.html"><span class="doc std std-doc">Dependency injection</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_core.console.html"><span class="doc std std-doc">Console</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl.core.application.html"><span class="doc std std-doc">Application base</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl.core.dependency_injection.html"><span class="doc std std-doc">Dependency injection</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl.core.console.html"><span class="doc std std-doc">Console</span></a></p></li>
|
||||
</ul>
|
||||
<!-- LINKS -->
|
||||
</section>
|
||||
|
||||
4
docs/build/html/search.html
vendored
4
docs/build/html/search.html
vendored
@@ -48,9 +48,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
2
docs/build/html/searchindex.js
vendored
2
docs/build/html/searchindex.js
vendored
File diff suppressed because one or more lines are too long
8
docs/build/html/setup.html
vendored
8
docs/build/html/setup.html
vendored
@@ -64,9 +64,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -146,7 +146,7 @@
|
||||
</section>
|
||||
<section id="create-initial-console-app">
|
||||
<h2>Create initial console app<a class="headerlink" href="#create-initial-console-app" title="Permalink to this heading"></a></h2>
|
||||
<p>You develop apps and packages in the context of an CPL project which is defined in an cpl_core.json.</p>
|
||||
<p>You develop apps and packages in the context of an CPL project which is defined in an cpl.core.json.</p>
|
||||
<ol class="arabic">
|
||||
<li><p>Run the CLI command <code class="docutils literal notranslate"><span class="pre">cpl</span> <span class="pre">new</span> <span class="pre">console</span></code> and provide the name my-app, as shown here:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl<span class="w"> </span>new<span class="w"> </span>console<span class="w"> </span>my-app
|
||||
@@ -159,7 +159,7 @@
|
||||
</section>
|
||||
<section id="create-initial-library">
|
||||
<h2>Create initial library<a class="headerlink" href="#create-initial-library" title="Permalink to this heading"></a></h2>
|
||||
<p>You develop apps and packages in the context of an CPL project which is defined in an cpl_core.json.</p>
|
||||
<p>You develop apps and packages in the context of an CPL project which is defined in an cpl.core.json.</p>
|
||||
<ol class="arabic">
|
||||
<li><p>Run the CLI command <code class="docutils literal notranslate"><span class="pre">cpl</span> <span class="pre">new</span> <span class="pre">library</span></code> and provide the name my-lib, as shown here:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl<span class="w"> </span>new<span class="w"> </span>library<span class="w"> </span>my-lib
|
||||
|
||||
6
docs/build/html/tutorials.appsettings.html
vendored
6
docs/build/html/tutorials.appsettings.html
vendored
@@ -56,7 +56,7 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console-arguments.html">Handle console arguments</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html">Use cpl_core.console.Console</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html">Use cpl.core.console.Console</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.logging.html">Use builtin logger</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.mail.html">Send mails</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.templating.html">Using cpl g & cpl n templating</a></li>
|
||||
@@ -67,9 +67,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
10
docs/build/html/tutorials.console-arguments.html
vendored
10
docs/build/html/tutorials.console-arguments.html
vendored
@@ -19,7 +19,7 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Use cpl_core.console.Console" href="tutorials.console.html" />
|
||||
<link rel="next" title="Use cpl.core.console.Console" href="tutorials.console.html" />
|
||||
<link rel="prev" title="Using appsettings.json" href="tutorials.appsettings.html" />
|
||||
</head>
|
||||
|
||||
@@ -56,7 +56,7 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="#coming-soon">Coming soon</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html">Use cpl_core.console.Console</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html">Use cpl.core.console.Console</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.logging.html">Use builtin logger</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.mail.html">Send mails</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.templating.html">Using cpl g & cpl n templating</a></li>
|
||||
@@ -67,9 +67,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -111,7 +111,7 @@
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="tutorials.appsettings.html" class="btn btn-neutral float-left" title="Using appsettings.json" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="tutorials.console.html" class="btn btn-neutral float-right" title="Use cpl_core.console.Console" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="tutorials.console.html" class="btn btn-neutral float-right" title="Use cpl.core.console.Console" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
12
docs/build/html/tutorials.console.html
vendored
12
docs/build/html/tutorials.console.html
vendored
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Use cpl_core.console.Console — Common Python Library documentation</title>
|
||||
<title>Use cpl.core.console.Console — Common Python Library documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -53,7 +53,7 @@
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.extend-startup.html">Extend startup</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.appsettings.html">Using appsettings.json</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console-arguments.html">Handle console arguments</a></li>
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Use cpl_core.console.Console</a><ul>
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Use cpl.core.console.Console</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#coming-soon">Coming soon</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -67,9 +67,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -89,7 +89,7 @@
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="getting_started.html">Getting started</a></li>
|
||||
<li class="breadcrumb-item"><a href="tutorials.html">Tutorials</a></li>
|
||||
<li class="breadcrumb-item active">Use cpl_core.console.Console</li>
|
||||
<li class="breadcrumb-item active">Use cpl.core.console.Console</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/tutorials.console.md.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@@ -100,7 +100,7 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="use-cpl-core-console-console">
|
||||
<h1>Use cpl_core.console.Console<a class="headerlink" href="#use-cpl-core-console-console" title="Permalink to this heading"></a></h1>
|
||||
<h1>Use cpl.core.console.Console<a class="headerlink" href="#use-cpl-core-console-console" title="Permalink to this heading"></a></h1>
|
||||
<section id="coming-soon">
|
||||
<h2>Coming soon<a class="headerlink" href="#coming-soon" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
|
||||
@@ -56,7 +56,7 @@
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.extend-startup.html">Extend startup</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.appsettings.html">Using appsettings.json</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console-arguments.html">Handle console arguments</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html">Use cpl_core.console.Console</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html">Use cpl.core.console.Console</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.logging.html">Use builtin logger</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.mail.html">Send mails</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.templating.html">Using cpl g & cpl n templating</a></li>
|
||||
@@ -67,9 +67,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@@ -56,7 +56,7 @@
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.extend-startup.html">Extend startup</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.appsettings.html">Using appsettings.json</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console-arguments.html">Handle console arguments</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html">Use cpl_core.console.Console</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html">Use cpl.core.console.Console</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.logging.html">Use builtin logger</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.mail.html">Send mails</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.templating.html">Using cpl g & cpl n templating</a></li>
|
||||
@@ -67,9 +67,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@@ -56,7 +56,7 @@
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.appsettings.html">Using appsettings.json</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console-arguments.html">Handle console arguments</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html">Use cpl_core.console.Console</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html">Use cpl.core.console.Console</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.logging.html">Use builtin logger</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.mail.html">Send mails</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.templating.html">Using cpl g & cpl n templating</a></li>
|
||||
@@ -67,9 +67,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
8
docs/build/html/tutorials.html
vendored
8
docs/build/html/tutorials.html
vendored
@@ -53,7 +53,7 @@
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.extend-startup.html">Extend startup</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.appsettings.html">Using appsettings.json</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console-arguments.html">Handle console arguments</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html">Use cpl_core.console.Console</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html">Use cpl.core.console.Console</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.logging.html">Use builtin logger</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.mail.html">Send mails</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.templating.html">Using cpl g & cpl n templating</a></li>
|
||||
@@ -64,9 +64,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -119,7 +119,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="tutorials.console-arguments.html#coming-soon">Coming soon</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tutorials.console.html">Use cpl_core.console.Console</a><ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tutorials.console.html">Use cpl.core.console.Console</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="tutorials.console.html#coming-soon">Coming soon</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
10
docs/build/html/tutorials.logging.html
vendored
10
docs/build/html/tutorials.logging.html
vendored
@@ -20,7 +20,7 @@
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Send mails" href="tutorials.mail.html" />
|
||||
<link rel="prev" title="Use cpl_core.console.Console" href="tutorials.console.html" />
|
||||
<link rel="prev" title="Use cpl.core.console.Console" href="tutorials.console.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -53,7 +53,7 @@
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.extend-startup.html">Extend startup</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.appsettings.html">Using appsettings.json</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console-arguments.html">Handle console arguments</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html">Use cpl_core.console.Console</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html">Use cpl.core.console.Console</a></li>
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Use builtin logger</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#coming-soon">Coming soon</a></li>
|
||||
</ul>
|
||||
@@ -67,9 +67,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -110,7 +110,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="tutorials.console.html" class="btn btn-neutral float-left" title="Use cpl_core.console.Console" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="tutorials.console.html" class="btn btn-neutral float-left" title="Use cpl.core.console.Console" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="tutorials.mail.html" class="btn btn-neutral float-right" title="Send mails" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
|
||||
6
docs/build/html/tutorials.mail.html
vendored
6
docs/build/html/tutorials.mail.html
vendored
@@ -53,7 +53,7 @@
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.extend-startup.html">Extend startup</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.appsettings.html">Using appsettings.json</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console-arguments.html">Handle console arguments</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html">Use cpl_core.console.Console</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html">Use cpl.core.console.Console</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.logging.html">Use builtin logger</a></li>
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Send mails</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#coming-soon">Coming soon</a></li>
|
||||
@@ -67,9 +67,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
16
docs/build/html/tutorials.templating.html
vendored
16
docs/build/html/tutorials.templating.html
vendored
@@ -53,7 +53,7 @@
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.extend-startup.html">Extend startup</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.appsettings.html">Using appsettings.json</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console-arguments.html">Handle console arguments</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html">Use cpl_core.console.Console</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html">Use cpl.core.console.Console</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.logging.html">Use builtin logger</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="tutorials.mail.html">Send mails</a></li>
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#">Using cpl g & cpl n templating</a><ul>
|
||||
@@ -70,9 +70,9 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -173,7 +173,7 @@ First of all, for information, it is very important not to overwrite any existin
|
||||
<p>Here the template <code class="docutils literal notranslate"><span class="pre">project_console.py</span></code> defines how a console project has to look like when it is generated. Here is the code to illustrate this:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">cpl_cli.abc.project_type_abc</span> <span class="kn">import</span> <span class="n">ProjectTypeABC</span>
|
||||
<span class="kn">from</span> <span class="nn">cpl_cli.configuration</span> <span class="kn">import</span> <span class="n">WorkspaceSettings</span>
|
||||
<span class="kn">from</span> <span class="nn">cpl_core.utils</span> <span class="kn">import</span> <span class="n">String</span>
|
||||
<span class="kn">from</span> <span class="nn">cpl.core.utils</span> <span class="kn">import</span> <span class="n">String</span>
|
||||
|
||||
|
||||
<span class="k">class</span> <span class="nc">Console</span><span class="p">(</span><span class="n">ProjectTypeABC</span><span class="p">):</span>
|
||||
@@ -236,10 +236,10 @@ Now create a class for normal files which inherits from <code class="docutils li
|
||||
<span class="kn">import</span> <span class="nn">textwrap</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">textwrap</span><span class="o">.</span><span class="n">dedent</span><span class="p">(</span><span class="s2">"""</span><span class="se">\</span>
|
||||
<span class="s2"> from cpl_core.application import StartupABC</span>
|
||||
<span class="s2"> from cpl_core.configuration import ConfigurationABC</span>
|
||||
<span class="s2"> from cpl_core.dependency_injection import ServiceProviderABC, ServiceCollectionABC</span>
|
||||
<span class="s2"> from cpl_core.environment import ApplicationEnvironment</span>
|
||||
<span class="s2"> from cpl.core.application import StartupABC</span>
|
||||
<span class="s2"> from cpl.core.configuration import ConfigurationABC</span>
|
||||
<span class="s2"> from cpl.core.dependency_injection import ServiceProviderABC, ServiceCollectionABC</span>
|
||||
<span class="s2"> from cpl.core.environment import ApplicationEnvironment</span>
|
||||
<span class="s2"> </span>
|
||||
<span class="s2"> </span>
|
||||
<span class="s2"> class Startup(StartupABC):</span>
|
||||
|
||||
Reference in New Issue
Block a user