|
diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
index 8d377346..0bf5cfa6 100644
--- a/docs/build/html/searchindex.js
+++ b/docs/build/html/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["cli.add","cli.build","cli.generate","cli.help","cli.install","cli.new","cli.overview","cli.publish","cli.remove","cli.start","cli.uninstall","cli.update","cli.version","contributing","cpl_cli","cpl_core","cpl_core.application","cpl_core.configuration","cpl_core.console","cpl_core.database","cpl_core.database.connection","cpl_core.database.context","cpl_core.dependency_injection","cpl_core.environment","cpl_core.logging","cpl_core.mailing","cpl_core.time","cpl_core.utils","cpl_query","cpl_query.exceptions","cpl_query.extension","cpl_query.tests","getting_started","index","introduction","modules","quickstart","setup"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["cli.add.md","cli.build.md","cli.generate.md","cli.help.md","cli.install.md","cli.new.md","cli.overview.md","cli.publish.md","cli.remove.md","cli.start.md","cli.uninstall.md","cli.update.md","cli.version.md","contributing.md","cpl_cli.rst","cpl_core.rst","cpl_core.application.rst","cpl_core.configuration.rst","cpl_core.console.rst","cpl_core.database.rst","cpl_core.database.connection.rst","cpl_core.database.context.rst","cpl_core.dependency_injection.rst","cpl_core.environment.rst","cpl_core.logging.rst","cpl_core.mailing.rst","cpl_core.time.rst","cpl_core.utils.rst","cpl_query.rst","cpl_query.exceptions.rst","cpl_query.extension.rst","cpl_query.tests.rst","getting_started.rst","index.rst","introduction.md","modules.rst","quickstart.md","setup.md"],objects:{"cpl_core.application":{application_abc:[16,0,0,"-"],application_builder:[16,0,0,"-"],application_builder_abc:[16,0,0,"-"],startup_abc:[16,0,0,"-"]},"cpl_core.application.application_abc":{ApplicationABC:[16,1,1,""]},"cpl_core.application.application_abc.ApplicationABC":{configure:[16,2,1,""],main:[16,2,1,""],run:[16,2,1,""]},"cpl_core.application.application_builder":{ApplicationBuilder:[16,1,1,""]},"cpl_core.application.application_builder.ApplicationBuilder":{build:[16,2,1,""],use_extension:[16,2,1,""],use_startup:[16,2,1,""]},"cpl_core.application.application_builder_abc":{ApplicationBuilderABC:[16,1,1,""]},"cpl_core.application.application_builder_abc.ApplicationBuilderABC":{build:[16,2,1,""],use_startup:[16,2,1,""]},"cpl_core.application.startup_abc":{StartupABC:[16,1,1,""]},"cpl_core.application.startup_abc.StartupABC":{configure_configuration:[16,2,1,""],configure_services:[16,2,1,""]},"cpl_core.configuration":{configuration:[17,0,0,"-"],configuration_abc:[17,0,0,"-"],configuration_model_abc:[17,0,0,"-"],configuration_variable_name_enum:[17,0,0,"-"],console_argument:[17,0,0,"-"]},"cpl_core.configuration.configuration":{Configuration:[17,1,1,""]},"cpl_core.configuration.configuration.Configuration":{add_configuration:[17,2,1,""],add_console_argument:[17,2,1,""],add_console_arguments:[17,2,1,""],add_environment_variables:[17,2,1,""],add_json_file:[17,2,1,""],additional_arguments:[17,3,1,""],argument_error_function:[17,3,1,""],environment:[17,3,1,""],get_configuration:[17,2,1,""]},"cpl_core.configuration.configuration_abc":{ConfigurationABC:[17,1,1,""]},"cpl_core.configuration.configuration_abc.ConfigurationABC":{add_configuration:[17,2,1,""],add_console_argument:[17,2,1,""],add_console_arguments:[17,2,1,""],add_environment_variables:[17,2,1,""],add_json_file:[17,2,1,""],additional_arguments:[17,3,1,""],argument_error_function:[17,3,1,""],environment:[17,3,1,""],get_configuration:[17,2,1,""]},"cpl_core.configuration.configuration_model_abc":{ConfigurationModelABC:[17,1,1,""]},"cpl_core.configuration.configuration_model_abc.ConfigurationModelABC":{from_dict:[17,2,1,""]},"cpl_core.configuration.configuration_variable_name_enum":{ConfigurationVariableNameEnum:[17,1,1,""]},"cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum":{customer:[17,4,1,""],environment:[17,4,1,""],name:[17,4,1,""],to_list:[17,2,1,""]},"cpl_core.configuration.console_argument":{ConsoleArgument:[17,1,1,""]},"cpl_core.configuration.console_argument.ConsoleArgument":{aliases:[17,3,1,""],console_arguments:[17,3,1,""],is_value_token_optional:[17,3,1,""],name:[17,3,1,""],token:[17,3,1,""],value_token:[17,3,1,""]},"cpl_core.console":{background_color_enum:[18,0,0,"-"],console:[18,0,0,"-"],console_call:[18,0,0,"-"],foreground_color_enum:[18,0,0,"-"],spinner_thread:[18,0,0,"-"]},"cpl_core.console.background_color_enum":{BackgroundColorEnum:[18,1,1,""]},"cpl_core.console.background_color_enum.BackgroundColorEnum":{"default":[18,4,1,""],blue:[18,4,1,""],cyan:[18,4,1,""],green:[18,4,1,""],grey:[18,4,1,""],magenta:[18,4,1,""],red:[18,4,1,""],white:[18,4,1,""],yellow:[18,4,1,""]},"cpl_core.console.console":{Console:[18,1,1,""]},"cpl_core.console.console.Console":{background_color:[18,3,1,""],banner:[18,2,1,""],clear:[18,2,1,""],close:[18,2,1,""],color_reset:[18,2,1,""],disable:[18,2,1,""],enable:[18,2,1,""],error:[18,2,1,""],foreground_color:[18,3,1,""],read:[18,2,1,""],read_line:[18,2,1,""],reset_cursor_position:[18,2,1,""],select:[18,2,1,""],set_background_color:[18,2,1,""],set_cursor_position:[18,2,1,""],set_foreground_color:[18,2,1,""],set_hold_back:[18,2,1,""],spinner:[18,2,1,""],table:[18,2,1,""],write:[18,2,1,""],write_at:[18,2,1,""],write_line:[18,2,1,""],write_line_at:[18,2,1,""]},"cpl_core.console.console_call":{ConsoleCall:[18,1,1,""]},"cpl_core.console.console_call.ConsoleCall":{"function":[18,3,1,""],args:[18,3,1,""]},"cpl_core.console.foreground_color_enum":{ForegroundColorEnum:[18,1,1,""]},"cpl_core.console.foreground_color_enum.ForegroundColorEnum":{"default":[18,4,1,""],blue:[18,4,1,""],cyan:[18,4,1,""],green:[18,4,1,""],grey:[18,4,1,""],magenta:[18,4,1,""],red:[18,4,1,""],white:[18,4,1,""],yellow:[18,4,1,""]},"cpl_core.console.spinner_thread":{SpinnerThread:[18,1,1,""]},"cpl_core.console.spinner_thread.SpinnerThread":{exit:[18,2,1,""],run:[18,2,1,""],stop_spinning:[18,2,1,""]},"cpl_core.database":{database_model:[19,0,0,"-"],database_settings:[19,0,0,"-"],database_settings_name_enum:[19,0,0,"-"]},"cpl_core.database.connection":{database_connection:[20,0,0,"-"],database_connection_abc:[20,0,0,"-"]},"cpl_core.database.connection.database_connection":{DatabaseConnection:[20,1,1,""]},"cpl_core.database.connection.database_connection.DatabaseConnection":{connect:[20,2,1,""],engine:[20,3,1,""],session:[20,3,1,""]},"cpl_core.database.connection.database_connection_abc":{DatabaseConnectionABC:[20,1,1,""]},"cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC":{connect:[20,2,1,""],engine:[20,3,1,""],session:[20,3,1,""]},"cpl_core.database.context":{database_context:[21,0,0,"-"],database_context_abc:[21,0,0,"-"]},"cpl_core.database.context.database_context":{DatabaseContext:[21,1,1,""]},"cpl_core.database.context.database_context.DatabaseContext":{connect:[21,2,1,""],engine:[21,3,1,""],save_changes:[21,2,1,""],session:[21,3,1,""]},"cpl_core.database.context.database_context_abc":{DatabaseContextABC:[21,1,1,""]},"cpl_core.database.context.database_context_abc.DatabaseContextABC":{connect:[21,2,1,""],engine:[21,3,1,""],save_changes:[21,2,1,""],session:[21,3,1,""]},"cpl_core.database.database_settings":{DatabaseSettings:[19,1,1,""]},"cpl_core.database.database_settings.DatabaseSettings":{auth_plugin:[19,3,1,""],case_sensitive:[19,3,1,""],connection_string:[19,3,1,""],credentials:[19,3,1,""],echo:[19,3,1,""],encoding:[19,3,1,""],from_dict:[19,2,1,""]},"cpl_core.database.database_settings_name_enum":{DatabaseSettingsNameEnum:[19,1,1,""]},"cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum":{auth_plugin:[19,4,1,""],case_sensitive:[19,4,1,""],connection_string:[19,4,1,""],credentials:[19,4,1,""],echo:[19,4,1,""],encoding:[19,4,1,""]},"cpl_core.dependency_injection":{service_collection:[22,0,0,"-"],service_collection_abc:[22,0,0,"-"],service_descriptor:[22,0,0,"-"],service_lifetime_enum:[22,0,0,"-"],service_provider:[22,0,0,"-"],service_provider_abc:[22,0,0,"-"]},"cpl_core.dependency_injection.service_collection":{ServiceCollection:[22,1,1,""]},"cpl_core.dependency_injection.service_collection.ServiceCollection":{add_db_context:[22,2,1,""],add_logging:[22,2,1,""],add_scoped:[22,2,1,""],add_singleton:[22,2,1,""],add_transient:[22,2,1,""],build_service_provider:[22,2,1,""]},"cpl_core.dependency_injection.service_collection_abc":{ServiceCollectionABC:[22,1,1,""]},"cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC":{add_db_context:[22,2,1,""],add_logging:[22,2,1,""],add_scoped:[22,2,1,""],add_singleton:[22,2,1,""],add_transient:[22,2,1,""],build_service_provider:[22,2,1,""]},"cpl_core.dependency_injection.service_descriptor":{ServiceDescriptor:[22,1,1,""]},"cpl_core.dependency_injection.service_descriptor.ServiceDescriptor":{implementation:[22,3,1,""],lifetime:[22,3,1,""],service_type:[22,3,1,""]},"cpl_core.dependency_injection.service_lifetime_enum":{ServiceLifetimeEnum:[22,1,1,""]},"cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum":{"transient":[22,4,1,""],scoped:[22,4,1,""],singleton:[22,4,1,""]},"cpl_core.dependency_injection.service_provider":{ServiceProvider:[22,1,1,""]},"cpl_core.dependency_injection.service_provider.ServiceProvider":{build_service:[22,2,1,""],get_service:[22,2,1,""]},"cpl_core.dependency_injection.service_provider_abc":{ServiceProviderABC:[22,1,1,""]},"cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC":{build_service:[22,2,1,""],get_service:[22,2,1,""]},"cpl_core.environment":{application_environment:[23,0,0,"-"],application_environment_abc:[23,0,0,"-"],environment_name_enum:[23,0,0,"-"]},"cpl_core.environment.application_environment":{ApplicationEnvironment:[23,1,1,""]},"cpl_core.environment.application_environment.ApplicationEnvironment":{application_name:[23,3,1,""],customer:[23,3,1,""],date_time_now:[23,3,1,""],end_time:[23,3,1,""],environment_name:[23,3,1,""],host_name:[23,3,1,""],runtime_directory:[23,3,1,""],set_runtime_directory:[23,2,1,""],set_working_directory:[23,2,1,""],start_time:[23,3,1,""],working_directory:[23,3,1,""]},"cpl_core.environment.application_environment_abc":{ApplicationEnvironmentABC:[23,1,1,""]},"cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC":{application_name:[23,3,1,""],customer:[23,3,1,""],date_time_now:[23,3,1,""],end_time:[23,3,1,""],environment_name:[23,3,1,""],host_name:[23,3,1,""],runtime_directory:[23,3,1,""],set_runtime_directory:[23,2,1,""],set_working_directory:[23,2,1,""],start_time:[23,3,1,""],working_directory:[23,3,1,""]},"cpl_core.environment.environment_name_enum":{EnvironmentNameEnum:[23,1,1,""]},"cpl_core.environment.environment_name_enum.EnvironmentNameEnum":{development:[23,4,1,""],production:[23,4,1,""],staging:[23,4,1,""],testing:[23,4,1,""]},"cpl_core.logging":{logger_abc:[24,0,0,"-"],logger_service:[24,0,0,"-"],logging_level_enum:[24,0,0,"-"],logging_settings:[24,0,0,"-"],logging_settings_name_enum:[24,0,0,"-"]},"cpl_core.logging.logger_abc":{LoggerABC:[24,1,1,""]},"cpl_core.logging.logger_abc.LoggerABC":{debug:[24,2,1,""],error:[24,2,1,""],fatal:[24,2,1,""],header:[24,2,1,""],info:[24,2,1,""],trace:[24,2,1,""],warn:[24,2,1,""]},"cpl_core.logging.logger_service":{Logger:[24,1,1,""]},"cpl_core.logging.logger_service.Logger":{create:[24,2,1,""],debug:[24,2,1,""],error:[24,2,1,""],fatal:[24,2,1,""],header:[24,2,1,""],info:[24,2,1,""],trace:[24,2,1,""],warn:[24,2,1,""]},"cpl_core.logging.logging_level_enum":{LoggingLevelEnum:[24,1,1,""]},"cpl_core.logging.logging_level_enum.LoggingLevelEnum":{DEBUG:[24,4,1,""],ERROR:[24,4,1,""],FATAL:[24,4,1,""],INFO:[24,4,1,""],OFF:[24,4,1,""],TRACE:[24,4,1,""],WARN:[24,4,1,""]},"cpl_core.logging.logging_settings":{LoggingSettings:[24,1,1,""]},"cpl_core.logging.logging_settings.LoggingSettings":{console:[24,3,1,""],filename:[24,3,1,""],from_dict:[24,2,1,""],level:[24,3,1,""],path:[24,3,1,""]},"cpl_core.logging.logging_settings_name_enum":{LoggingSettingsNameEnum:[24,1,1,""]},"cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum":{console_level:[24,4,1,""],file_level:[24,4,1,""],filename:[24,4,1,""],path:[24,4,1,""]},"cpl_core.mailing":{email:[25,0,0,"-"],email_client_abc:[25,0,0,"-"],email_client_service:[25,0,0,"-"],email_client_settings:[25,0,0,"-"],email_client_settings_name_enum:[25,0,0,"-"]},"cpl_core.mailing.email":{EMail:[25,1,1,""]},"cpl_core.mailing.email.EMail":{add_header:[25,2,1,""],add_receiver:[25,2,1,""],body:[25,3,1,""],check_mail:[25,2,1,""],get_content:[25,2,1,""],header:[25,3,1,""],header_list:[25,3,1,""],receiver:[25,3,1,""],receiver_list:[25,3,1,""],subject:[25,3,1,""],transceiver:[25,3,1,""]},"cpl_core.mailing.email_client_abc":{EMailClientABC:[25,1,1,""]},"cpl_core.mailing.email_client_abc.EMailClientABC":{connect:[25,2,1,""],send_mail:[25,2,1,""]},"cpl_core.mailing.email_client_service":{EMailClient:[25,1,1,""]},"cpl_core.mailing.email_client_service.EMailClient":{connect:[25,2,1,""],create:[25,2,1,""],login:[25,2,1,""],send_mail:[25,2,1,""]},"cpl_core.mailing.email_client_settings":{EMailClientSettings:[25,1,1,""]},"cpl_core.mailing.email_client_settings.EMailClientSettings":{credentials:[25,3,1,""],from_dict:[25,2,1,""],host:[25,3,1,""],port:[25,3,1,""],user_name:[25,3,1,""]},"cpl_core.mailing.email_client_settings_name_enum":{EMailClientSettingsNameEnum:[25,1,1,""]},"cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum":{credentials:[25,4,1,""],host:[25,4,1,""],port:[25,4,1,""],user_name:[25,4,1,""]},"cpl_core.time":{time_format_settings:[26,0,0,"-"],time_format_settings_names_enum:[26,0,0,"-"]},"cpl_core.time.time_format_settings":{TimeFormatSettings:[26,1,1,""]},"cpl_core.time.time_format_settings.TimeFormatSettings":{date_format:[26,3,1,""],date_time_format:[26,3,1,""],date_time_log_format:[26,3,1,""],from_dict:[26,2,1,""],time_format:[26,3,1,""]},"cpl_core.time.time_format_settings_names_enum":{TimeFormatSettingsNamesEnum:[26,1,1,""]},"cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum":{date_format:[26,4,1,""],date_time_format:[26,4,1,""],date_time_log_format:[26,4,1,""],time_format:[26,4,1,""]},"cpl_core.utils":{credential_manager:[27,0,0,"-"],pip:[27,0,0,"-"],string:[27,0,0,"-"]},"cpl_core.utils.credential_manager":{CredentialManager:[27,1,1,""]},"cpl_core.utils.credential_manager.CredentialManager":{build_string:[27,2,1,""],decrypt:[27,2,1,""],encrypt:[27,2,1,""]},"cpl_core.utils.pip":{Pip:[27,1,1,""]},"cpl_core.utils.pip.Pip":{get_executable:[27,2,1,""],get_outdated:[27,2,1,""],get_package:[27,2,1,""],install:[27,2,1,""],reset_executable:[27,2,1,""],set_executable:[27,2,1,""],uninstall:[27,2,1,""]},"cpl_core.utils.string":{String:[27,1,1,""]},"cpl_core.utils.string.String":{convert_to_camel_case:[27,2,1,""],convert_to_snake_case:[27,2,1,""],first_to_lower:[27,2,1,""],first_to_upper:[27,2,1,""],random_string:[27,2,1,""]},"cpl_query.exceptions":{ArgumentNoneException:[29,5,1,""],ExceptionArgument:[29,1,1,""],IndexOutOfRangeException:[29,5,1,""],InvalidTypeException:[29,5,1,""],WrongTypeException:[29,5,1,""]},"cpl_query.exceptions.ExceptionArgument":{func:[29,4,1,""],index:[29,4,1,""],list:[29,4,1,""],type:[29,4,1,""],value:[29,4,1,""]},"cpl_query.extension":{iterable_abc:[30,0,0,"-"],list:[30,0,0,"-"],ordered_iterable_abc:[30,0,0,"-"]},"cpl_query.extension.iterable_abc":{IterableABC:[30,1,1,""]},"cpl_query.extension.iterable_abc.IterableABC":{all:[30,2,1,""],any:[30,2,1,""],append:[30,2,1,""],average:[30,2,1,""],contains:[30,2,1,""],count:[30,2,1,""],distinct:[30,2,1,""],element_at:[30,2,1,""],element_at_or_default:[30,2,1,""],extend:[30,2,1,""],first:[30,2,1,""],first_or_default:[30,2,1,""],for_each:[30,2,1,""],last:[30,2,1,""],last_or_default:[30,2,1,""],max:[30,2,1,""],min:[30,2,1,""],order_by:[30,2,1,""],order_by_descending:[30,2,1,""],reverse:[30,2,1,""],single:[30,2,1,""],single_or_default:[30,2,1,""],skip:[30,2,1,""],skip_last:[30,2,1,""],sum:[30,2,1,""],take:[30,2,1,""],take_last:[30,2,1,""],to_list:[30,2,1,""],type:[30,3,1,""],where:[30,2,1,""]},"cpl_query.extension.list":{List:[30,1,1,""]},"cpl_query.extension.ordered_iterable_abc":{OrderedIterableABC:[30,1,1,""]},"cpl_query.extension.ordered_iterable_abc.OrderedIterableABC":{then_by:[30,2,1,""],then_by_descending:[30,2,1,""]},"cpl_query.tests":{iterable_test:[31,0,0,"-"],models:[31,0,0,"-"],query_test:[31,0,0,"-"],tester:[31,0,0,"-"]},"cpl_query.tests.iterable_test":{IterableTest:[31,1,1,""]},"cpl_query.tests.iterable_test.IterableTest":{setUp:[31,2,1,""],test_append:[31,2,1,""]},"cpl_query.tests.models":{Address:[31,1,1,""],User:[31,1,1,""]},"cpl_query.tests.query_test":{QueryTest:[31,1,1,""]},"cpl_query.tests.query_test.QueryTest":{setUp:[31,2,1,""],test_all:[31,2,1,""],test_any:[31,2,1,""],test_avg:[31,2,1,""],test_contains:[31,2,1,""],test_count:[31,2,1,""],test_distinct:[31,2,1,""],test_element_at:[31,2,1,""],test_element_at_or_default:[31,2,1,""],test_first:[31,2,1,""],test_first_or_default:[31,2,1,""],test_for_each:[31,2,1,""],test_last:[31,2,1,""],test_last_or_default:[31,2,1,""],test_max:[31,2,1,""],test_min:[31,2,1,""],test_order_by:[31,2,1,""],test_order_by_descending:[31,2,1,""],test_reverse:[31,2,1,""],test_single:[31,2,1,""],test_single_or_default:[31,2,1,""],test_skip:[31,2,1,""],test_skip_last:[31,2,1,""],test_sum:[31,2,1,""],test_take:[31,2,1,""],test_take_last:[31,2,1,""],test_then_by:[31,2,1,""],test_then_by_descending:[31,2,1,""],test_where:[31,2,1,""]},"cpl_query.tests.tester":{Tester:[31,1,1,""]},"cpl_query.tests.tester.Tester":{create:[31,2,1,""],start:[31,2,1,""]},cpl_query:{exceptions:[29,0,0,"-"],tests:[31,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","property","Python property"],"4":["py","attribute","Python attribute"],"5":["py","exception","Python exception"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:property","4":"py:attribute","5":"py:exception"},terms:{"0":[22,24,36],"1":[22,24,36],"14":[20,21],"2":[22,24,36],"3":24,"4":24,"5":[24,36],"6":24,"8":13,"9":[20,21],"abstract":[2,16,17,20,21,22,23,24,25,30],"byte":27,"case":[13,27,31,36],"char":[18,27],"class":[2,16,17,18,19,20,21,22,23,24,25,26,27,29,30,31],"default":[18,37],"do":[33,36],"enum":[2,17,18,19,22,23,24,25,26,29],"float":30,"function":[18,27,30,36],"import":[13,36],"int":[18,25,27,30,36],"new":[6,13,14,18,35,36,37],"public":13,"return":[17,18,22,25,30,36],"short":[3,6],"static":[17,25,27],"transient":22,"true":17,"while":13,A:[0,5,13],As:13,Be:13,By:13,For:13,IN:30,If:[0,5,8,13,37],In:[6,13,36],Such:13,That:13,The:[1,2,4,5,6,7,8,10,13,22,25,27,33,34,36,37],These:33,To:[6,13,36,37],With:6,__init__:[20,21,36],__main__:36,__name__:36,_func:30,_iterableabc__iter:30,_iterableabc__object:30,abc:[2,16,17,18,20,21,22,23,24,25,30],abl:13,about:[33,37],absolut:6,accept:13,activ:18,ad:[0,13],add:[5,6,13,14,17,22,25,35,36],add_configur:17,add_console_argu:17,add_db_context:22,add_environment_vari:17,add_head:25,add_json_fil:17,add_log:22,add_receiv:25,add_scop:22,add_singleton:22,add_transi:22,addit:[6,13],additional_argu:17,address:[25,31],agre:13,alia:6,alias:[6,17],all:[1,7,12,13,30],allow:13,alreadi:[13,36,37],also:[36,37],an:[1,6,7,17,18,19,22,23,24,25,26,29,36,37],ani:[6,18,30],api:[13,33,34,35],app:[1,6,16,32,33,34,35,36],append:30,appli:13,applic:[5,9,15,18,23,24,25,33,34,35,36,37],application_abc:[15,35],application_build:[15,35],application_builder_abc:[15,35],application_environ:[15,35],application_environment_abc:[15,16,17,24,25,35],application_extension_abc:16,application_nam:23,applicationabc:16,applicationbuild:16,applicationbuilderabc:16,applicationenviron:23,applicationenvironmentabc:[16,17,23,24,25],applicationextensionabc:16,appropri:13,appset:[16,36],ar:[6,7,13],arg:[16,18,21,27,29],argument:[1,5,6,7,14,17,18,27,29,35],argument_error_funct:17,argumentnoneexcept:29,artifact:6,ascend:30,ascii_lett:36,ascii_lowercas:36,ascii_uppercas:36,ask:13,attribut:[17,19,24,25,26],auth_plugin:19,authplugin:19,automat:13,avail:[3,6,13],averag:30,b:[1,6,13],back:[13,18],background:18,background_color:18,background_color_enum:[15,35],backgroundcolorenum:18,banner:18,base64:27,base:[2,16,17,18,19,20,21,22,23,24,25,26,27,29,30,31,36],basic:[14,35,36,37],been:13,befor:[13,18,31],behavior:13,better:13,bit:13,blue:18,bodi:25,bool:[17,18,19,25,30],branch:13,build:[6,7,14,16,27,35,36,37],build_servic:22,build_service_provid:22,build_str:27,call:[0,8,16,18],callabl:[17,18,22,30],camel:27,camelcas:27,can:[0,1,6,7,8,13,33,37],case_sensit:19,casesensit:19,cd:[6,37],chang:[6,9,13,21,36],channel:13,charact:18,check:25,check_mail:25,checkout:13,chnage:37,choic:36,citizen:13,classmethod:[18,27],clear:18,cli:[12,32,33,34,35,36],close:[13,18],code:[36,37],codebas:13,collect:[17,18,22,30],color:18,color_reset:18,command:[0,1,3,5,7,8,13,14,27,35,37],commandnameoralia:6,commit:13,common:[33,34],commun:13,complex:[30,33,34],config:[16,22],configmodel:2,configur:[15,16,19,22,24,25,26,35],configuration_abc:[15,16,22,35],configuration_model_abc:[15,19,24,25,26,35],configuration_variable_name_enum:[15,35],configurationabc:[16,17,22],configurationmodelabc:[17,19,24,25,26],configurationvariablenameenum:17,configure_configur:16,configure_servic:16,confirm:13,connect:[15,19,21,25,35],connection_str:[19,20,21],connectionstr:19,consid:13,consist:13,consol:[1,3,5,6,7,15,17,24,32,35,36],console_argu:[15,35],console_cal:[15,35],console_level:24,consoleargu:17,consolecal:18,consoleloglevel:24,contain:[16,30],content:[14,32,35],context:[15,19,22,35,37],continu:36,contributor:13,convert:[17,24,25,26,27],convert_to_camel_cas:27,convert_to_snake_cas:27,coordin:[13,18],copi:1,core:[20,21],count:[13,30],cpl:[6,14,20,21,22,32,37],cpl_core:[7,15,35,36,37],cpl_queri:[28,35],craft:13,creat:[6,7,13,16,22,24,25,27,31,32,33,34,35],credenti:[19,25,27],credential_manag:[15,35],credentialmanag:27,current:[6,23],cursor:18,cursor_background_color:18,cursor_foreground_color:18,custom:[16,17,23],cyan:18,d:13,data:7,databas:[15,22,35],database_connect:[15,19,35],database_connection_abc:[15,19,35],database_context:[15,19,35],database_context_abc:[15,19,22,35],database_model:[15,35],database_set:[15,20,21,22,35],database_settings_name_enum:[15,35],databaseconnect:20,databaseconnectionabc:20,databasecontext:21,databasecontextabc:[21,22],databaseset:[19,20,21,22],databasesettingsnameenum:19,date_format:26,date_time_format:26,date_time_log_format:26,date_time_now:23,dateformat:26,datetim:23,datetimeformat:26,datetimelogformat:26,db_context:22,db_context_typ:22,db_set:22,de:[13,37],debug:24,declin:37,decod:27,decrypt:27,def:36,defin:[6,17,37],delet:8,deped:4,depend:[6,11,36],dependency_inject:[15,16,35],descend:30,describ:13,descript:[6,14,35],descriptor:22,design:13,desktop:[33,34],detail:33,determin:13,develop:[6,13,23,33,34,36,37],dict:[17,18,19,24,25,26],directli:[1,13],directori:[1,6,7,23,36],disabl:18,discuss:13,dist:[6,7],distinct:30,doc:[20,21],document:13,doesn:13,don:[13,36],done:36,duplic:13,e:25,each:6,echo:19,edit:13,edraft:[13,37],edraft_d:[20,21],effici:[33,34],effort:13,either:6,element:[18,30],element_at:30,element_at_or_default:30,elif:36,email:[15,35],email_client_abc:[15,35],email_client_servic:[15,35],email_client_set:[15,35],email_client_settings_name_enum:[15,35],emailcli:25,emailclientabc:25,emailclientset:25,emailclientsettingsnameenum:25,emul:36,en:[20,21],enabl:[18,36],encod:[19,27],encrypt:27,end:[18,24,30],end_tim:23,engin:[20,21],enough:13,ensur:13,enter:37,enterpris:[33,34],entri:[16,18],enumer:[17,18,19,22,23,24,25,26,29],env:[16,20,21,24],environ:[15,16,17,24,25,32,35],environment_nam:23,environment_name_enum:[15,35],environmentnameenum:23,error:[17,18,24],essenti:[13,36],even:13,everyth:33,ex:24,except:[24,28,35],exceptionargu:29,execut:[1,6,7,27],exercis:31,exist:13,exit:[18,36],explor:36,extend:30,extens:[16,28,35],extra:[27,37],extract:13,fatal:24,featur:37,file:[1,2,6,7,8,9,13,17,37],file_level:24,fileloglevel:24,filenam:24,find:13,first:[6,13,27,30,33,34],first_or_default:30,first_to_low:27,first_to_upp:27,fix:13,fixtur:31,fixup:13,folder:36,follow:[6,13,36,37],for_each:30,fore:37,foreground:18,foreground_color:18,foreground_color_enum:[15,35],foregroundcolorenum:18,fork:13,format:[6,24,26],forth:13,found:17,from:[0,6,7,8,10,12,13,16,17,19,20,21,30,33,34,36],from_dict:[17,19,24,25,26],full:36,func:[29,30],g:[2,6],gener:[5,6,7,14,35,36,37],generate_password:36,get:[27,33,34,35,37],get_configur:17,get_cont:25,get_execut:27,get_outd:27,get_packag:27,get_servic:22,git:13,git_sh:[20,21],gitea:13,give:13,given:[0,1,4,6,7,10,17,18,19,22,27],go:[6,13,33],good:13,great:33,green:18,grei:18,guid:13,h:[3,6],ha:[0,18],handl:[18,27],hard:13,have:[6,13,36,37],haven:13,head:13,header:[18,24,25],header_background_color:18,header_foreground_color:18,header_list:25,hear:13,hello:[36,37],help:[6,13,14,33,34,35],here:[13,37],hold:18,home:[20,21],hook:31,host:25,host_nam:23,html:[20,21],http:[20,21,37],i:[4,6,36],id:36,immedi:6,implement:[13,22,30],includ:[1,13,37],index:[27,29,30,36,37],indexoutofrangeexcept:29,info:[13,24],inform:[13,24,37],initi:[5,32,35],inject:36,input:[18,36],instal:[6,12,14,27,32,35,36],instanc:[16,22],instance_typ:22,interact:18,intern:22,introduc:36,invalid:[17,29],invalidtypeexcept:29,investig:13,is_value_token_opt:17,isol:13,issus:13,iter:30,iterable_abc:[28,35],iterableabc:30,iterabletest:31,its:[6,13],join:36,json:[7,17,36,37],keep:13,kei:37,key_typ:17,keyword:18,known:17,kwarg:18,languag:[14,35],larger:13,last:[18,30],last_or_default:30,launch:37,learn:[33,34,37],len:36,length:[18,27,36],letter:36,level:24,lib:[20,21,37],librari:[1,5,6,7,32,33,34,35],licens:36,lifetim:22,like:[13,36],line:[13,18,36],list:[3,6,12,17,18,22,25,27,28,29,35],live:37,load:16,local:[27,32,35],log:[15,25,35],logfil:24,logger:[22,24,25],logger_abc:[15,25,35],logger_servic:[15,35],loggerabc:[24,25],logging_level_enum:[15,35],logging_set:[15,35],logging_settings_name_enum:[15,35],logginglevelenum:24,loggingset:24,loggingsettingsnameenum:24,login:25,look:36,love:13,lower:[27,36],magenta:18,mail:[15,35],mail_set:25,main:[16,36],maintain:13,major:13,make:[13,37],manag:13,master:13,max:30,mayb:13,md:36,meant:[33,34],member:13,menu:[18,32,35],messag:[3,18,24],method:[13,31],methodnam:31,might:13,min:30,mind:13,minim:13,mit:13,modul:[20,21],more:[13,37],most:[6,36,37],msg_len:18,must:[0,1,6,8,13],my:[6,13,37],n:[5,6,36,37],name:[0,1,2,5,6,7,8,17,23,24,27,31,37],navig:37,need:[13,36,37],next:[18,32,35],nextcloud_sven:[20,21],none:[17,18,22,24,25,27,29,30,31],note:13,nr:31,number:30,object:[16,17,18,22,25,27,30,31],occur:17,occurr:30,off:24,often:13,on_blu:18,on_cyan:18,on_default:18,on_green:18,on_grei:18,on_magenta:18,on_r:18,on_whit:18,on_yellow:18,one:13,onli:36,open:[13,36,37],option:[6,13,17,18,22,24,25,27,30,36],option_background_color:18,option_foreground_color:18,optionalsarg:6,order:[13,30],order_bi:30,order_by_descend:30,ordered_iterable_abc:[28,35],orderediterableabc:30,orderedlist:30,org:[20,21],origin:13,orm:[20,21],otherwis:[0,8],ouput:36,our:13,out:[13,29,36,37],outdat:27,outlin:13,output:[1,6,7,17,18,36,37],outsid:13,overview:[14,35,37],own:6,p:[6,7],packag:[4,5,6,10,12,20,21,27,32,33,34,35,36],page:33,parent:6,password:36,patch:13,path:[0,1,7,8,14,17,23,24,35,37],pep:13,pip:[4,10,12,15,35,36,37],place:[17,30],platform:[33,34],pleas:13,point:[13,16,18],port:25,posit:18,possibl:13,pr:13,prefix:[6,17],prepar:[1,6,7,13,16],prerequisit:[32,35],press:37,prevent:13,print:[18,36],problem:13,proce:13,process:13,product:23,program:24,project:[0,1,4,6,7,8,10,11,13,14,32,35,37],projectmain:36,prompt:37,properti:[17,18,19,20,21,22,23,24,25,26,30],propos:13,provid:[13,16,22,36,37],publish:[1,6,14,35,37],push:13,py:[6,7,20,21,27,36],pycharm:36,pyhton:37,python3:[20,21],python:[1,13,27,33,34,36,37],queri:[33,34,35],querytest:31,question:13,quickli:13,r:[6,8],random:[27,36],random_str:27,rang:[29,36],re:13,read:[17,18,36],read_lin:18,readi:[13,37],readili:13,readm:36,realli:13,receiv:25,receiver_list:25,red:18,refer:[0,8,33,34,35],referenc:0,rel:[14,35],relat:13,remov:[0,6,7,14,35],replac:27,repo:13,repositori:13,repres:[18,19,23,25],represent:[20,21,22,24,25,26],reproduc:13,reproduct:13,requir:13,requiredarg:6,reserv:13,reset:[18,27],reset_cursor_posit:18,reset_execut:27,restart:[6,9,37],result:[25,27],revers:30,right:13,rm:13,root:6,run:[1,5,16,18,27,36,37],runtest:31,runtim:23,runtime_directori:23,s:[6,9,13,32,35],same:6,sampl:36,save:[13,17,21],save_chang:21,scenario:13,schemat:[14,35],schreibtisch:[20,21],scope:22,search:[13,17,22],search_typ:17,section:36,see:[5,13,20,21,36,37],select:[18,36],send:[13,25],send_mail:25,serv:6,server:[6,25,33,34,37],servic:[2,16,22,24,25,36],service_collect:[15,35],service_collection_abc:[15,16,35],service_descriptor:[15,35],service_lifetime_enum:[15,35],service_provid:[15,35],service_provider_abc:[15,16,35],service_typ:22,servicecollect:22,servicecollectionabc:[16,22],servicedescriptor:22,servicelifetimeenum:22,serviceprovid:22,serviceproviderabc:[16,22],session:[20,21],set:[2,16,17,18,19,22,23,24,25,26,27,31,32,35,36],set_background_color:18,set_cursor_posit:18,set_execut:27,set_foreground_color:18,set_hold_back:18,set_runtime_directori:23,set_working_directori:23,setup:[6,7,31,34,37],sh:[13,37],sh_cpl:[13,20,21,37],should:[17,36,37],show:[3,18],shown:[6,17,37],significantli:13,similar:37,simpl:[5,33,34,37],singl:30,single_or_default:30,singleton:22,site:[20,21],size:13,skip:30,skip_last:30,small:13,snake:27,snake_cas:27,so:[13,37],some:6,sometim:13,soon:13,sort:30,sourc:[0,1,7,13,27,36,37],specifi:[0,6,8,17],spinner:18,spinner_background_color:18,spinner_foreground_color:18,spinner_thread:[15,35],spinnerthread:18,sqlalchemi:[20,21],src:36,stage:23,standard:27,start:[6,14,31,33,34,35],start_tim:23,startup:16,startup_abc:[15,35],startupabc:16,statement:6,stderr:27,stdout:27,step:13,stop:18,stop_spin:18,store:17,str:[0,1,2,3,4,5,7,8,10,17,18,19,20,21,23,24,25,26,27,36],street:31,string:[15,18,20,21,24,25,35,36],style:13,subject:25,submodul:[15,35],subprocess:27,success:37,successfulli:13,sum:30,suppli:6,sure:13,sven:[20,21],syntax:[14,35],system:27,t:[13,30,36],tabl:[14,18,27,32,35],take:[6,17,30],take_last:30,target:[0,1],tb:18,team:13,termin:[6,18,36,37],test:[13,23,36],test_al:31,test_ani:31,test_append:31,test_avg:31,test_contain:31,test_count:31,test_distinct:31,test_element_at:31,test_element_at_or_default:31,test_first:31,test_first_or_default:31,test_for_each:31,test_last:31,test_last_or_default:31,test_max:31,test_min:31,test_order_bi:31,test_order_by_descend:31,test_revers:31,test_singl:31,test_single_or_default:31,test_skip:31,test_skip_last:31,test_sum:31,test_tak:31,test_take_last:31,test_then_bi:31,test_then_by_descend:31,test_wher:31,testcas:31,text:18,text_background_color:18,text_foreground_color:18,than:13,thank:13,them:1,themselv:13,then_bi:30,then_by_descend:30,thi:[3,13,16,33,34,36,37],those:37,thread:[2,18],through:36,throughout:13,thrown:24,time:[13,15,24,35],time_format:[24,26],time_format_set:[15,24,35],time_format_settings_names_enum:[15,35],timeformat:26,timeformatset:[24,26],timeformatsettingsnamesenum:26,to_list:[17,30],todai:13,token:17,topic:13,trace:24,traceback:18,tracker:13,transceiv:25,tree:24,tutori:[36,37],type:[0,1,2,3,4,7,8,10,14,16,17,22,29,30,35],u:[6,11],ui:[6,10],ultim:13,under:13,understand:[13,33,34,36,37],unexpect:29,unfortun:13,uninstal:[6,14,27,35],union:[17,18,22,30],unit:13,unittest:31,up:[31,32,35],updat:[6,13,14,35],upfront:13,upper:[27,36],url:[27,37],us:[0,1,6,7,8,13,16,18,25,27,33,34,36,37],use_extens:16,use_startup:16,user:[31,36],user_nam:25,usernam:25,util:[15,35],v:[6,12],valid:[25,36],valu:[0,1,2,3,4,5,7,8,10,17,18,19,22,23,24,25,26,29,30],value_token:17,variabl:[17,27],ve:36,version:[6,14,35],via:[4,10,13],vs:36,wa:[17,37],walk:36,want:[13,36],warn:24,watch:37,we:[13,36],wealth:13,welcom:36,well:13,what:[32,35],when:[18,29],where:30,whether:17,which:[0,6,17,18,27,37],white:18,who:13,window:37,within:[1,6,13],without:[4,6,13],work:[6,13,23],workaround:13,workflow:[14,35],working_directori:23,workspac:[0,1,5,6,8,32,35],world:[36,37],would:13,write:[13,18,24],write_at:18,write_lin:[18,36],write_line_at:18,wrongtypeexcept:29,x:18,y:[18,36],yellow:18,you:[0,1,6,8,13,33,34,36,37],your:[4,6,9,13,33,34,37]},titles:["cpl add","cpl build","cpl generate","cpl help","cpl install","cpl new","CLI Overview and Command Reference","cpl publish","cpl remove","cpl start","cpl uninstall","cpl update","cpl version","Contributing to CPL","CLI Reference","API Reference","cpl_core.application","cpl_core.configuration","cpl_core.console","cpl_core.database","cpl_core.database.connection","cpl_core.database.context","cpl_core.dependency_injection","cpl_core.environment","cpl_core.logging","cpl_core.mailing","cpl_core.time","cpl_core.utils","Query Reference","cpl_query.exceptions","cpl_query.extension","cpl_query.tests package","Getting started","Introduction to the CPL Docs","Introduction to the CPL Docs","cpl","Getting started with CPL","Setting up the local environment and workspace"],titleterms:{"new":5,add:0,address:13,an:13,api:15,app:37,applic:16,application_abc:16,application_build:16,application_builder_abc:16,application_environ:23,application_environment_abc:23,argument:[0,2,3,4,8,10],background_color_enum:18,basic:6,bug:13,build:1,cli:[6,14,37],code:13,command:6,configur:17,configuration_abc:17,configuration_model_abc:17,configuration_variable_name_enum:17,connect:20,consol:[18,37],console_argu:17,console_cal:18,content:[0,1,2,4,5,6,7,8,10,31,36,37],context:21,contribut:13,cpl:[0,1,2,3,4,5,7,8,9,10,11,12,13,33,34,35,36],cpl_core:[16,17,18,19,20,21,22,23,24,25,26,27],cpl_queri:[29,30,31],creat:[36,37],credential_manag:27,databas:[19,20,21],database_connect:20,database_connection_abc:20,database_context:21,database_context_abc:21,database_model:19,database_set:19,database_settings_name_enum:19,dependency_inject:22,descript:[0,1,2,3,4,5,7,8,10],doc:[33,34],email:25,email_client_abc:25,email_client_servic:25,email_client_set:25,email_client_settings_name_enum:25,environ:[23,37],environment_name_enum:23,except:29,explor:34,extens:30,featur:13,feedback:13,foreground_color_enum:18,found:13,gener:2,get:[32,36],guidelin:13,help:3,initi:37,instal:[4,37],introduct:[33,34],issu:13,iterable_abc:30,iterable_test:31,languag:6,librari:37,licens:13,list:30,local:37,log:24,logger_abc:24,logger_servic:24,logging_level_enum:24,logging_set:24,logging_settings_name_enum:24,mail:25,manual:33,menu:36,model:31,modul:31,next:[36,37],ordered_iterable_abc:30,overview:6,packag:[31,37],path:6,pip:27,prerequisit:[36,37],project:[5,36],publish:7,pull:13,queri:28,query_test:31,refer:[6,14,15,28],rel:6,remov:8,request:13,review:13,rule:13,s:[36,37],schemat:[2,6],service_collect:22,service_collection_abc:22,service_descriptor:22,service_lifetime_enum:22,service_provid:22,service_provider_abc:22,set:37,spinner_thread:18,start:[9,32,36,37],startup_abc:16,string:27,submiss:13,submit:13,submodul:[19,31],syntax:6,tabl:[6,36,37],test:31,tester:31,time:26,time_format_set:26,time_format_settings_names_enum:26,type:5,uninstal:10,up:37,updat:11,util:27,version:12,what:[36,37],workflow:6,workspac:37}})
\ No newline at end of file
+Search.setIndex({docnames:["cli.add","cli.build","cli.generate","cli.help","cli.install","cli.new","cli.overview","cli.publish","cli.remove","cli.start","cli.uninstall","cli.update","cli.version","contributing","cpl_cli","cpl_core","cpl_core.application","cpl_core.configuration","cpl_core.console","cpl_core.database","cpl_core.database.connection","cpl_core.database.context","cpl_core.dependency_injection","cpl_core.environment","cpl_core.logging","cpl_core.mailing","cpl_core.time","cpl_core.utils","cpl_query","cpl_query.exceptions","cpl_query.extension","cpl_query.tests","getting_started","index","introduction","modules","quickstart","setup"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["cli.add.md","cli.build.md","cli.generate.md","cli.help.md","cli.install.md","cli.new.md","cli.overview.md","cli.publish.md","cli.remove.md","cli.start.md","cli.uninstall.md","cli.update.md","cli.version.md","contributing.md","cpl_cli.rst","cpl_core.rst","cpl_core.application.rst","cpl_core.configuration.rst","cpl_core.console.rst","cpl_core.database.rst","cpl_core.database.connection.rst","cpl_core.database.context.rst","cpl_core.dependency_injection.rst","cpl_core.environment.rst","cpl_core.logging.rst","cpl_core.mailing.rst","cpl_core.time.rst","cpl_core.utils.rst","cpl_query.rst","cpl_query.exceptions.rst","cpl_query.extension.rst","cpl_query.tests.rst","getting_started.rst","index.rst","introduction.md","modules.rst","quickstart.md","setup.md"],objects:{"cpl_core.application":{application_abc:[16,0,0,"-"],application_builder:[16,0,0,"-"],application_builder_abc:[16,0,0,"-"],startup_abc:[16,0,0,"-"]},"cpl_core.application.application_abc":{ApplicationABC:[16,1,1,""]},"cpl_core.application.application_abc.ApplicationABC":{configure:[16,2,1,""],main:[16,2,1,""],run:[16,2,1,""]},"cpl_core.application.application_builder":{ApplicationBuilder:[16,1,1,""]},"cpl_core.application.application_builder.ApplicationBuilder":{build:[16,2,1,""],use_extension:[16,2,1,""],use_startup:[16,2,1,""]},"cpl_core.application.application_builder_abc":{ApplicationBuilderABC:[16,1,1,""]},"cpl_core.application.application_builder_abc.ApplicationBuilderABC":{build:[16,2,1,""],use_startup:[16,2,1,""]},"cpl_core.application.startup_abc":{StartupABC:[16,1,1,""]},"cpl_core.application.startup_abc.StartupABC":{configure_configuration:[16,2,1,""],configure_services:[16,2,1,""]},"cpl_core.configuration":{configuration:[17,0,0,"-"],configuration_abc:[17,0,0,"-"],configuration_model_abc:[17,0,0,"-"],configuration_variable_name_enum:[17,0,0,"-"],console_argument:[17,0,0,"-"]},"cpl_core.configuration.configuration":{Configuration:[17,1,1,""]},"cpl_core.configuration.configuration.Configuration":{add_configuration:[17,2,1,""],add_console_argument:[17,2,1,""],add_console_arguments:[17,2,1,""],add_environment_variables:[17,2,1,""],add_json_file:[17,2,1,""],additional_arguments:[17,3,1,""],argument_error_function:[17,3,1,""],environment:[17,3,1,""],get_configuration:[17,2,1,""]},"cpl_core.configuration.configuration_abc":{ConfigurationABC:[17,1,1,""]},"cpl_core.configuration.configuration_abc.ConfigurationABC":{add_configuration:[17,2,1,""],add_console_argument:[17,2,1,""],add_console_arguments:[17,2,1,""],add_environment_variables:[17,2,1,""],add_json_file:[17,2,1,""],additional_arguments:[17,3,1,""],argument_error_function:[17,3,1,""],environment:[17,3,1,""],get_configuration:[17,2,1,""]},"cpl_core.configuration.configuration_model_abc":{ConfigurationModelABC:[17,1,1,""]},"cpl_core.configuration.configuration_model_abc.ConfigurationModelABC":{from_dict:[17,2,1,""]},"cpl_core.configuration.configuration_variable_name_enum":{ConfigurationVariableNameEnum:[17,1,1,""]},"cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum":{customer:[17,4,1,""],environment:[17,4,1,""],name:[17,4,1,""],to_list:[17,2,1,""]},"cpl_core.configuration.console_argument":{ConsoleArgument:[17,1,1,""]},"cpl_core.configuration.console_argument.ConsoleArgument":{aliases:[17,3,1,""],console_arguments:[17,3,1,""],is_value_token_optional:[17,3,1,""],name:[17,3,1,""],token:[17,3,1,""],value_token:[17,3,1,""]},"cpl_core.console":{background_color_enum:[18,0,0,"-"],console:[18,0,0,"-"],console_call:[18,0,0,"-"],foreground_color_enum:[18,0,0,"-"],spinner_thread:[18,0,0,"-"]},"cpl_core.console.background_color_enum":{BackgroundColorEnum:[18,1,1,""]},"cpl_core.console.background_color_enum.BackgroundColorEnum":{"default":[18,4,1,""],blue:[18,4,1,""],cyan:[18,4,1,""],green:[18,4,1,""],grey:[18,4,1,""],magenta:[18,4,1,""],red:[18,4,1,""],white:[18,4,1,""],yellow:[18,4,1,""]},"cpl_core.console.console":{Console:[18,1,1,""]},"cpl_core.console.console.Console":{background_color:[18,3,1,""],banner:[18,2,1,""],clear:[18,2,1,""],close:[18,2,1,""],color_reset:[18,2,1,""],disable:[18,2,1,""],enable:[18,2,1,""],error:[18,2,1,""],foreground_color:[18,3,1,""],read:[18,2,1,""],read_line:[18,2,1,""],reset_cursor_position:[18,2,1,""],select:[18,2,1,""],set_background_color:[18,2,1,""],set_cursor_position:[18,2,1,""],set_foreground_color:[18,2,1,""],set_hold_back:[18,2,1,""],spinner:[18,2,1,""],table:[18,2,1,""],write:[18,2,1,""],write_at:[18,2,1,""],write_line:[18,2,1,""],write_line_at:[18,2,1,""]},"cpl_core.console.console_call":{ConsoleCall:[18,1,1,""]},"cpl_core.console.console_call.ConsoleCall":{"function":[18,3,1,""],args:[18,3,1,""]},"cpl_core.console.foreground_color_enum":{ForegroundColorEnum:[18,1,1,""]},"cpl_core.console.foreground_color_enum.ForegroundColorEnum":{"default":[18,4,1,""],blue:[18,4,1,""],cyan:[18,4,1,""],green:[18,4,1,""],grey:[18,4,1,""],magenta:[18,4,1,""],red:[18,4,1,""],white:[18,4,1,""],yellow:[18,4,1,""]},"cpl_core.console.spinner_thread":{SpinnerThread:[18,1,1,""]},"cpl_core.console.spinner_thread.SpinnerThread":{exit:[18,2,1,""],run:[18,2,1,""],stop_spinning:[18,2,1,""]},"cpl_core.database":{database_model:[19,0,0,"-"],database_settings:[19,0,0,"-"],database_settings_name_enum:[19,0,0,"-"]},"cpl_core.database.connection":{database_connection:[20,0,0,"-"],database_connection_abc:[20,0,0,"-"]},"cpl_core.database.connection.database_connection":{DatabaseConnection:[20,1,1,""]},"cpl_core.database.connection.database_connection.DatabaseConnection":{connect:[20,2,1,""],engine:[20,3,1,""],session:[20,3,1,""]},"cpl_core.database.connection.database_connection_abc":{DatabaseConnectionABC:[20,1,1,""]},"cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC":{connect:[20,2,1,""],engine:[20,3,1,""],session:[20,3,1,""]},"cpl_core.database.context":{database_context:[21,0,0,"-"],database_context_abc:[21,0,0,"-"]},"cpl_core.database.context.database_context":{DatabaseContext:[21,1,1,""]},"cpl_core.database.context.database_context.DatabaseContext":{connect:[21,2,1,""],engine:[21,3,1,""],save_changes:[21,2,1,""],session:[21,3,1,""]},"cpl_core.database.context.database_context_abc":{DatabaseContextABC:[21,1,1,""]},"cpl_core.database.context.database_context_abc.DatabaseContextABC":{connect:[21,2,1,""],engine:[21,3,1,""],save_changes:[21,2,1,""],session:[21,3,1,""]},"cpl_core.database.database_settings":{DatabaseSettings:[19,1,1,""]},"cpl_core.database.database_settings.DatabaseSettings":{auth_plugin:[19,3,1,""],case_sensitive:[19,3,1,""],connection_string:[19,3,1,""],credentials:[19,3,1,""],echo:[19,3,1,""],encoding:[19,3,1,""],from_dict:[19,2,1,""]},"cpl_core.database.database_settings_name_enum":{DatabaseSettingsNameEnum:[19,1,1,""]},"cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum":{auth_plugin:[19,4,1,""],case_sensitive:[19,4,1,""],connection_string:[19,4,1,""],credentials:[19,4,1,""],echo:[19,4,1,""],encoding:[19,4,1,""]},"cpl_core.dependency_injection":{service_collection:[22,0,0,"-"],service_collection_abc:[22,0,0,"-"],service_descriptor:[22,0,0,"-"],service_lifetime_enum:[22,0,0,"-"],service_provider:[22,0,0,"-"],service_provider_abc:[22,0,0,"-"]},"cpl_core.dependency_injection.service_collection":{ServiceCollection:[22,1,1,""]},"cpl_core.dependency_injection.service_collection.ServiceCollection":{add_db_context:[22,2,1,""],add_logging:[22,2,1,""],add_scoped:[22,2,1,""],add_singleton:[22,2,1,""],add_transient:[22,2,1,""],build_service_provider:[22,2,1,""]},"cpl_core.dependency_injection.service_collection_abc":{ServiceCollectionABC:[22,1,1,""]},"cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC":{add_db_context:[22,2,1,""],add_logging:[22,2,1,""],add_scoped:[22,2,1,""],add_singleton:[22,2,1,""],add_transient:[22,2,1,""],build_service_provider:[22,2,1,""]},"cpl_core.dependency_injection.service_descriptor":{ServiceDescriptor:[22,1,1,""]},"cpl_core.dependency_injection.service_descriptor.ServiceDescriptor":{implementation:[22,3,1,""],lifetime:[22,3,1,""],service_type:[22,3,1,""]},"cpl_core.dependency_injection.service_lifetime_enum":{ServiceLifetimeEnum:[22,1,1,""]},"cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum":{"transient":[22,4,1,""],scoped:[22,4,1,""],singleton:[22,4,1,""]},"cpl_core.dependency_injection.service_provider":{ServiceProvider:[22,1,1,""]},"cpl_core.dependency_injection.service_provider.ServiceProvider":{build_service:[22,2,1,""],get_service:[22,2,1,""]},"cpl_core.dependency_injection.service_provider_abc":{ServiceProviderABC:[22,1,1,""]},"cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC":{build_service:[22,2,1,""],get_service:[22,2,1,""]},"cpl_core.environment":{application_environment:[23,0,0,"-"],application_environment_abc:[23,0,0,"-"],environment_name_enum:[23,0,0,"-"]},"cpl_core.environment.application_environment":{ApplicationEnvironment:[23,1,1,""]},"cpl_core.environment.application_environment.ApplicationEnvironment":{application_name:[23,3,1,""],customer:[23,3,1,""],date_time_now:[23,3,1,""],end_time:[23,3,1,""],environment_name:[23,3,1,""],host_name:[23,3,1,""],runtime_directory:[23,3,1,""],set_runtime_directory:[23,2,1,""],set_working_directory:[23,2,1,""],start_time:[23,3,1,""],working_directory:[23,3,1,""]},"cpl_core.environment.application_environment_abc":{ApplicationEnvironmentABC:[23,1,1,""]},"cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC":{application_name:[23,3,1,""],customer:[23,3,1,""],date_time_now:[23,3,1,""],end_time:[23,3,1,""],environment_name:[23,3,1,""],host_name:[23,3,1,""],runtime_directory:[23,3,1,""],set_runtime_directory:[23,2,1,""],set_working_directory:[23,2,1,""],start_time:[23,3,1,""],working_directory:[23,3,1,""]},"cpl_core.environment.environment_name_enum":{EnvironmentNameEnum:[23,1,1,""]},"cpl_core.environment.environment_name_enum.EnvironmentNameEnum":{development:[23,4,1,""],production:[23,4,1,""],staging:[23,4,1,""],testing:[23,4,1,""]},"cpl_core.logging":{logger_abc:[24,0,0,"-"],logger_service:[24,0,0,"-"],logging_level_enum:[24,0,0,"-"],logging_settings:[24,0,0,"-"],logging_settings_name_enum:[24,0,0,"-"]},"cpl_core.logging.logger_abc":{LoggerABC:[24,1,1,""]},"cpl_core.logging.logger_abc.LoggerABC":{debug:[24,2,1,""],error:[24,2,1,""],fatal:[24,2,1,""],header:[24,2,1,""],info:[24,2,1,""],trace:[24,2,1,""],warn:[24,2,1,""]},"cpl_core.logging.logger_service":{Logger:[24,1,1,""]},"cpl_core.logging.logger_service.Logger":{create:[24,2,1,""],debug:[24,2,1,""],error:[24,2,1,""],fatal:[24,2,1,""],header:[24,2,1,""],info:[24,2,1,""],trace:[24,2,1,""],warn:[24,2,1,""]},"cpl_core.logging.logging_level_enum":{LoggingLevelEnum:[24,1,1,""]},"cpl_core.logging.logging_level_enum.LoggingLevelEnum":{DEBUG:[24,4,1,""],ERROR:[24,4,1,""],FATAL:[24,4,1,""],INFO:[24,4,1,""],OFF:[24,4,1,""],TRACE:[24,4,1,""],WARN:[24,4,1,""]},"cpl_core.logging.logging_settings":{LoggingSettings:[24,1,1,""]},"cpl_core.logging.logging_settings.LoggingSettings":{console:[24,3,1,""],filename:[24,3,1,""],from_dict:[24,2,1,""],level:[24,3,1,""],path:[24,3,1,""]},"cpl_core.logging.logging_settings_name_enum":{LoggingSettingsNameEnum:[24,1,1,""]},"cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum":{console_level:[24,4,1,""],file_level:[24,4,1,""],filename:[24,4,1,""],path:[24,4,1,""]},"cpl_core.mailing":{email:[25,0,0,"-"],email_client_abc:[25,0,0,"-"],email_client_service:[25,0,0,"-"],email_client_settings:[25,0,0,"-"],email_client_settings_name_enum:[25,0,0,"-"]},"cpl_core.mailing.email":{EMail:[25,1,1,""]},"cpl_core.mailing.email.EMail":{add_header:[25,2,1,""],add_receiver:[25,2,1,""],body:[25,3,1,""],check_mail:[25,2,1,""],get_content:[25,2,1,""],header:[25,3,1,""],header_list:[25,3,1,""],receiver:[25,3,1,""],receiver_list:[25,3,1,""],subject:[25,3,1,""],transceiver:[25,3,1,""]},"cpl_core.mailing.email_client_abc":{EMailClientABC:[25,1,1,""]},"cpl_core.mailing.email_client_abc.EMailClientABC":{connect:[25,2,1,""],send_mail:[25,2,1,""]},"cpl_core.mailing.email_client_service":{EMailClient:[25,1,1,""]},"cpl_core.mailing.email_client_service.EMailClient":{connect:[25,2,1,""],create:[25,2,1,""],login:[25,2,1,""],send_mail:[25,2,1,""]},"cpl_core.mailing.email_client_settings":{EMailClientSettings:[25,1,1,""]},"cpl_core.mailing.email_client_settings.EMailClientSettings":{credentials:[25,3,1,""],from_dict:[25,2,1,""],host:[25,3,1,""],port:[25,3,1,""],user_name:[25,3,1,""]},"cpl_core.mailing.email_client_settings_name_enum":{EMailClientSettingsNameEnum:[25,1,1,""]},"cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum":{credentials:[25,4,1,""],host:[25,4,1,""],port:[25,4,1,""],user_name:[25,4,1,""]},"cpl_core.time":{time_format_settings:[26,0,0,"-"],time_format_settings_names_enum:[26,0,0,"-"]},"cpl_core.time.time_format_settings":{TimeFormatSettings:[26,1,1,""]},"cpl_core.time.time_format_settings.TimeFormatSettings":{date_format:[26,3,1,""],date_time_format:[26,3,1,""],date_time_log_format:[26,3,1,""],from_dict:[26,2,1,""],time_format:[26,3,1,""]},"cpl_core.time.time_format_settings_names_enum":{TimeFormatSettingsNamesEnum:[26,1,1,""]},"cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum":{date_format:[26,4,1,""],date_time_format:[26,4,1,""],date_time_log_format:[26,4,1,""],time_format:[26,4,1,""]},"cpl_core.utils":{credential_manager:[27,0,0,"-"],pip:[27,0,0,"-"],string:[27,0,0,"-"]},"cpl_core.utils.credential_manager":{CredentialManager:[27,1,1,""]},"cpl_core.utils.credential_manager.CredentialManager":{build_string:[27,2,1,""],decrypt:[27,2,1,""],encrypt:[27,2,1,""]},"cpl_core.utils.pip":{Pip:[27,1,1,""]},"cpl_core.utils.pip.Pip":{get_executable:[27,2,1,""],get_outdated:[27,2,1,""],get_package:[27,2,1,""],install:[27,2,1,""],reset_executable:[27,2,1,""],set_executable:[27,2,1,""],uninstall:[27,2,1,""]},"cpl_core.utils.string":{String:[27,1,1,""]},"cpl_core.utils.string.String":{convert_to_camel_case:[27,2,1,""],convert_to_snake_case:[27,2,1,""],first_to_lower:[27,2,1,""],first_to_upper:[27,2,1,""],random_string:[27,2,1,""]},"cpl_query.exceptions":{ArgumentNoneException:[29,5,1,""],ExceptionArgument:[29,1,1,""],IndexOutOfRangeException:[29,5,1,""],InvalidTypeException:[29,5,1,""],WrongTypeException:[29,5,1,""]},"cpl_query.exceptions.ExceptionArgument":{func:[29,4,1,""],index:[29,4,1,""],list:[29,4,1,""],type:[29,4,1,""],value:[29,4,1,""]},"cpl_query.extension":{iterable:[30,0,0,"-"],iterable_abc:[30,0,0,"-"],list:[30,0,0,"-"],ordered_iterable:[30,0,0,"-"],ordered_iterable_abc:[30,0,0,"-"]},"cpl_query.extension.iterable":{Iterable:[30,1,1,""]},"cpl_query.extension.iterable.Iterable":{all:[30,2,1,""],any:[30,2,1,""],average:[30,2,1,""],contains:[30,2,1,""],count:[30,2,1,""],distinct:[30,2,1,""],element_at:[30,2,1,""],element_at_or_default:[30,2,1,""],first:[30,2,1,""],first_or_default:[30,2,1,""],for_each:[30,2,1,""],last:[30,2,1,""],last_or_default:[30,2,1,""],max:[30,2,1,""],min:[30,2,1,""],order_by:[30,2,1,""],order_by_descending:[30,2,1,""],reverse:[30,2,1,""],single:[30,2,1,""],single_or_default:[30,2,1,""],skip:[30,2,1,""],skip_last:[30,2,1,""],sum:[30,2,1,""],take:[30,2,1,""],take_last:[30,2,1,""],where:[30,2,1,""]},"cpl_query.extension.iterable_abc":{IterableABC:[30,1,1,""]},"cpl_query.extension.iterable_abc.IterableABC":{all:[30,2,1,""],any:[30,2,1,""],append:[30,2,1,""],average:[30,2,1,""],contains:[30,2,1,""],count:[30,2,1,""],distinct:[30,2,1,""],element_at:[30,2,1,""],element_at_or_default:[30,2,1,""],extend:[30,2,1,""],first:[30,2,1,""],first_or_default:[30,2,1,""],for_each:[30,2,1,""],last:[30,2,1,""],last_or_default:[30,2,1,""],max:[30,2,1,""],min:[30,2,1,""],order_by:[30,2,1,""],order_by_descending:[30,2,1,""],reverse:[30,2,1,""],single:[30,2,1,""],single_or_default:[30,2,1,""],skip:[30,2,1,""],skip_last:[30,2,1,""],sum:[30,2,1,""],take:[30,2,1,""],take_last:[30,2,1,""],to_list:[30,2,1,""],type:[30,3,1,""],where:[30,2,1,""]},"cpl_query.extension.list":{List:[30,1,1,""]},"cpl_query.extension.ordered_iterable":{OrderedIterable:[30,1,1,""]},"cpl_query.extension.ordered_iterable.OrderedIterable":{then_by:[30,2,1,""],then_by_descending:[30,2,1,""]},"cpl_query.extension.ordered_iterable_abc":{OrderedIterableABC:[30,1,1,""]},"cpl_query.extension.ordered_iterable_abc.OrderedIterableABC":{then_by:[30,2,1,""],then_by_descending:[30,2,1,""]},"cpl_query.tests":{iterable_test:[31,0,0,"-"],models:[31,0,0,"-"],query_test:[31,0,0,"-"],tester:[31,0,0,"-"]},"cpl_query.tests.iterable_test":{IterableTest:[31,1,1,""]},"cpl_query.tests.iterable_test.IterableTest":{setUp:[31,2,1,""],test_append:[31,2,1,""]},"cpl_query.tests.models":{Address:[31,1,1,""],User:[31,1,1,""]},"cpl_query.tests.query_test":{QueryTest:[31,1,1,""]},"cpl_query.tests.query_test.QueryTest":{setUp:[31,2,1,""],test_all:[31,2,1,""],test_any:[31,2,1,""],test_avg:[31,2,1,""],test_contains:[31,2,1,""],test_count:[31,2,1,""],test_distinct:[31,2,1,""],test_element_at:[31,2,1,""],test_element_at_or_default:[31,2,1,""],test_first:[31,2,1,""],test_first_or_default:[31,2,1,""],test_for_each:[31,2,1,""],test_last:[31,2,1,""],test_last_or_default:[31,2,1,""],test_max:[31,2,1,""],test_min:[31,2,1,""],test_order_by:[31,2,1,""],test_order_by_descending:[31,2,1,""],test_reverse:[31,2,1,""],test_single:[31,2,1,""],test_single_or_default:[31,2,1,""],test_skip:[31,2,1,""],test_skip_last:[31,2,1,""],test_sum:[31,2,1,""],test_take:[31,2,1,""],test_take_last:[31,2,1,""],test_then_by:[31,2,1,""],test_then_by_descending:[31,2,1,""],test_where:[31,2,1,""]},"cpl_query.tests.tester":{Tester:[31,1,1,""]},"cpl_query.tests.tester.Tester":{create:[31,2,1,""],start:[31,2,1,""]},cpl_query:{exceptions:[29,0,0,"-"],tests:[31,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","property","Python property"],"4":["py","attribute","Python attribute"],"5":["py","exception","Python exception"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:property","4":"py:attribute","5":"py:exception"},terms:{"0":[22,24,36],"1":[22,24,36],"14":[20,21],"2":[22,24,36],"3":24,"4":24,"5":[24,36],"6":24,"8":13,"9":[20,21],"abstract":[2,16,17,20,21,22,23,24,25,30],"byte":27,"case":[13,27,31,36],"char":[18,27],"class":[2,16,17,18,19,20,21,22,23,24,25,26,27,29,30,31],"default":[18,37],"do":[33,36],"enum":[2,17,18,19,22,23,24,25,26,29],"float":30,"function":[18,27,30,36],"import":[13,36],"int":[18,25,27,30,36],"new":[6,13,14,18,35,36,37],"public":13,"return":[17,18,22,25,30,36],"short":[3,6],"static":[17,25,27],"transient":22,"true":17,"while":13,A:[0,5,13],As:13,Be:13,By:13,For:13,If:[0,5,8,13,37],In:[6,13,36],Such:13,That:13,The:[1,2,4,5,6,7,8,10,13,22,25,27,33,34,36,37],These:33,To:[6,13,36,37],With:6,__init__:[20,21,36],__iter:30,__main__:36,__name__:36,__object:30,_func:30,_iterableabc__iter:30,_iterableabc__object:30,abc:[2,16,17,18,20,21,22,23,24,25,30],abl:13,about:[33,37],absolut:6,accept:13,activ:18,ad:[0,13],add:[5,6,13,14,17,22,25,30,35,36],add_configur:17,add_console_argu:17,add_db_context:22,add_environment_vari:17,add_head:25,add_json_fil:17,add_log:22,add_receiv:25,add_scop:22,add_singleton:22,add_transi:22,addit:[6,13],additional_argu:17,address:[25,31],after:30,agre:13,alia:6,alias:[6,17],all:[1,7,12,13,30],allow:13,alreadi:[13,36,37],also:[36,37],an:[1,6,7,17,18,19,22,23,24,25,26,29,36,37],ani:[6,18,30],api:[13,33,34,35],app:[1,6,16,32,33,34,35,36],append:30,appli:13,applic:[5,9,15,18,23,24,25,33,34,35,36,37],application_abc:[15,35],application_build:[15,35],application_builder_abc:[15,35],application_environ:[15,35],application_environment_abc:[15,16,17,24,25,35],application_extension_abc:16,application_nam:23,applicationabc:16,applicationbuild:16,applicationbuilderabc:16,applicationenviron:23,applicationenvironmentabc:[16,17,23,24,25],applicationextensionabc:16,appropri:13,appset:[16,36],ar:[6,7,13],arg:[16,18,21,27,29],argument:[1,5,6,7,14,17,18,27,29,30,35],argument_error_funct:17,argumentnoneexcept:[29,30],artifact:6,ascend:30,ascii_lett:36,ascii_lowercas:36,ascii_uppercas:36,ask:13,attribut:[17,19,24,25,26],auth_plugin:19,authplugin:19,automat:13,avail:[3,6,13],averag:30,b:[1,6,13],back:[13,18],background:18,background_color:18,background_color_enum:[15,35],backgroundcolorenum:18,banner:18,base64:27,base:[2,16,17,18,19,20,21,22,23,24,25,26,27,29,30,31,36],basic:[14,35,36,37],been:13,befor:[13,18,31],behavior:13,better:13,bit:13,blue:18,bodi:25,bool:[17,18,19,25,30],branch:13,build:[6,7,14,16,27,35,36,37],build_servic:22,build_service_provid:22,build_str:27,call:[0,8,16,18,30],callabl:[17,18,22,30],camel:27,camelcas:27,can:[0,1,6,7,8,13,33,37],case_sensit:19,casesensit:19,cd:[6,37],chang:[6,9,13,21,36],channel:13,charact:18,check:[25,30],check_mail:25,checkout:13,chnage:37,choic:36,citizen:13,classmethod:[18,27],clear:18,cli:[12,32,33,34,35,36],close:[13,18],code:[36,37],codebas:13,collect:[17,18,22,30],color:18,color_reset:18,command:[0,1,3,5,7,8,13,14,27,35,37],commandnameoralia:6,commit:13,common:[33,34],commun:13,complex:[30,33,34],config:[16,22],configmodel:2,configur:[15,16,19,22,24,25,26,35],configuration_abc:[15,16,22,35],configuration_model_abc:[15,19,24,25,26,35],configuration_variable_name_enum:[15,35],configurationabc:[16,17,22],configurationmodelabc:[17,19,24,25,26],configurationvariablenameenum:17,configure_configur:16,configure_servic:16,confirm:13,connect:[15,19,21,25,35],connection_str:[19,20,21],connectionstr:19,consid:13,consist:13,consol:[1,3,5,6,7,15,17,24,32,35,36],console_argu:[15,35],console_cal:[15,35],console_level:24,consoleargu:17,consolecal:18,consoleloglevel:24,contain:[16,30],content:[14,32,35],context:[15,19,22,35,37],continu:36,contributor:13,convert:[17,24,25,26,27,30],convert_to_camel_cas:27,convert_to_snake_cas:27,coordin:[13,18],copi:1,core:[20,21],count:[13,30],cpl:[6,14,20,21,22,32,37],cpl_core:[7,15,35,36,37],cpl_queri:[28,35],craft:13,creat:[6,7,13,16,22,24,25,27,31,32,33,34,35],credenti:[19,25,27],credential_manag:[15,35],credentialmanag:27,current:[6,23],cursor:18,cursor_background_color:18,cursor_foreground_color:18,custom:[16,17,23],cyan:18,d:13,data:7,databas:[15,22,35],database_connect:[15,19,35],database_connection_abc:[15,19,35],database_context:[15,19,35],database_context_abc:[15,19,22,35],database_model:[15,35],database_set:[15,20,21,22,35],database_settings_name_enum:[15,35],databaseconnect:20,databaseconnectionabc:20,databasecontext:21,databasecontextabc:[21,22],databaseset:[19,20,21,22],databasesettingsnameenum:19,date_format:26,date_time_format:26,date_time_log_format:26,date_time_now:23,dateformat:26,datetim:23,datetimeformat:26,datetimelogformat:26,db_context:22,db_context_typ:22,db_set:22,de:[13,37],debug:24,declin:37,decod:27,decrypt:27,def:36,defin:[6,17,30,37],delet:8,deped:4,depend:[6,11,36],dependency_inject:[15,16,35],descend:30,describ:13,descript:[6,14,35],descriptor:22,design:13,desktop:[33,34],detail:33,determin:13,develop:[6,13,23,33,34,36,37],dict:[17,18,19,24,25,26],directli:[1,13],directori:[1,6,7,23,36],disabl:18,discuss:13,dist:[6,7],distinct:30,doc:[20,21],document:13,doesn:13,don:[13,36],done:36,duplic:13,e:25,each:[6,30],echo:19,edit:13,edraft:[13,37],edraft_d:[20,21],effici:[33,34],effort:13,either:6,element:[18,30],element_at:30,element_at_or_default:30,elif:36,email:[15,35],email_client_abc:[15,35],email_client_servic:[15,35],email_client_set:[15,35],email_client_settings_name_enum:[15,35],emailcli:25,emailclientabc:25,emailclientset:25,emailclientsettingsnameenum:25,emul:36,en:[20,21],enabl:[18,36],encod:[19,27],encrypt:27,end:[18,24],end_tim:23,engin:[20,21],enough:13,ensur:13,enter:37,enterpris:[33,34],entri:[16,18],enumer:[17,18,19,22,23,24,25,26,29],env:[16,20,21,24],environ:[15,16,17,24,25,32,35],environment_nam:23,environment_name_enum:[15,35],environmentnameenum:23,equal:30,error:[17,18,24],essenti:[13,36],even:13,everi:30,everyth:33,ex:24,except:[24,28,30,35],exceptionargu:29,execut:[1,6,7,27],exercis:31,exist:13,exit:[18,36],explor:36,extend:30,extens:[16,28,35],extra:[27,37],extract:13,fatal:24,featur:37,file:[1,2,6,7,8,9,13,17,37],file_level:24,fileloglevel:24,filenam:24,find:13,first:[6,13,27,30,33,34],first_or_default:30,first_to_low:27,first_to_upp:27,fix:13,fixtur:31,fixup:13,folder:36,follow:[6,13,36,37],for_each:30,fore:37,foreground:18,foreground_color:18,foreground_color_enum:[15,35],foregroundcolorenum:18,fork:13,format:[6,24,26],forth:13,found:[17,30],from:[0,6,7,8,10,12,13,16,17,19,20,21,30,33,34,36],from_dict:[17,19,24,25,26],full:36,func:[29,30],g:[2,6],gener:[5,6,7,14,35,36,37],generate_password:36,get:[27,33,34,35,37],get_configur:17,get_cont:25,get_execut:27,get_outd:27,get_packag:27,get_servic:22,git:13,git_sh:[20,21],gitea:13,give:13,given:[0,1,4,6,7,10,17,18,19,22,27,30],go:[6,13,33],good:13,great:33,green:18,grei:18,guid:13,h:[3,6],ha:[0,18],handl:[18,27],hard:13,have:[6,13,36,37],haven:13,head:13,header:[18,24,25],header_background_color:18,header_foreground_color:18,header_list:25,hear:13,hello:[36,37],help:[6,13,14,33,34,35],here:[13,37],highest:30,hold:18,home:[20,21],hook:31,host:25,host_nam:23,html:[20,21],http:[20,21,37],i:[4,6,36],id:36,immedi:6,implement:[13,22,30],includ:[1,13,37],index:[27,29,30,36,37],indexoutofrangeexcept:29,info:[13,24],inform:[13,24,37],initi:[5,32,35],inject:36,input:[18,36],instal:[6,12,14,27,32,35,36],instanc:[16,22],instance_typ:22,interact:18,intern:22,introduc:36,invalid:[17,29],invalidtypeexcept:29,investig:13,is_value_token_opt:17,isol:13,issus:13,iter:[28,35],iterable_abc:[28,35],iterableabc:30,iterabletest:31,its:[6,13],join:36,json:[7,17,36,37],keep:13,kei:37,key_typ:17,keyword:18,known:17,kwarg:18,languag:[14,35],larger:13,last:[18,30],last_or_default:30,launch:37,learn:[33,34,37],len:36,length:[18,27,30,36],letter:36,level:24,lib:[20,21,37],librari:[1,5,6,7,32,33,34,35],licens:36,lifetim:22,like:[13,36],line:[13,18,36],list:[3,6,12,17,18,22,25,27,28,29,35],live:37,load:16,local:[27,32,35],log:[15,25,35],logfil:24,logger:[22,24,25],logger_abc:[15,25,35],logger_servic:[15,35],loggerabc:[24,25],logging_level_enum:[15,35],logging_set:[15,35],logging_settings_name_enum:[15,35],logginglevelenum:24,loggingset:24,loggingsettingsnameenum:24,login:25,look:36,love:13,lower:[27,36],magenta:18,mail:[15,35],mail_set:25,main:[16,36],maintain:13,major:13,make:[13,37],manag:13,master:13,max:30,mayb:13,md:36,meant:[33,34],member:13,menu:[18,32,35],messag:[3,18,24],method:[13,31],methodnam:31,might:13,min:30,mind:13,minim:13,mit:13,modul:[20,21],more:[13,30,37],most:[6,36,37],msg_len:18,must:[0,1,6,8,13],my:[6,13,37],n:[5,6,36,37],name:[0,1,2,5,6,7,8,17,23,24,27,31,37],navig:37,need:[13,36,37],next:[18,32,35],nextcloud_sven:[20,21],none:[17,18,22,24,25,27,29,30,31],note:13,nr:31,object:[16,17,18,22,25,27,30,31],occur:17,off:24,often:13,on_blu:18,on_cyan:18,on_default:18,on_green:18,on_grei:18,on_magenta:18,on_r:18,on_whit:18,on_yellow:18,one:[13,30],onli:36,open:[13,36,37],option:[6,13,17,18,22,24,25,27,30,36],option_background_color:18,option_foreground_color:18,optionalsarg:6,order:[13,30],order_bi:30,order_by_descend:30,ordered_iter:[28,35],ordered_iterable_abc:[28,35],orderediter:30,orderediterableabc:30,orderedlist:30,org:[20,21],origin:13,orm:[20,21],otherwis:[0,8],ouput:36,our:13,out:[13,29,36,37],outdat:27,outlin:13,output:[1,6,7,17,18,36,37],outsid:13,overview:[14,35,37],own:6,p:[6,7],packag:[4,5,6,10,12,20,21,27,32,33,34,35,36],page:33,parent:6,password:36,patch:13,path:[0,1,7,8,14,17,23,24,35,37],pep:13,pip:[4,10,12,15,35,36,37],place:17,platform:[33,34],pleas:13,point:[13,16,18],port:25,posit:18,possibl:13,pr:13,prefix:[6,17],prepar:[1,6,7,13,16],prerequisit:[32,35],press:37,prevent:13,print:[18,36],problem:13,proce:13,process:13,product:23,program:24,project:[0,1,4,6,7,8,10,11,13,14,32,35,37],projectmain:36,prompt:37,properti:[17,18,19,20,21,22,23,24,25,26,30],propos:13,provid:[13,16,22,36,37],publish:[1,6,14,35,37],push:13,py:[6,7,20,21,27,36],pycharm:36,pyhton:37,python3:[20,21],python:[1,13,27,33,34,36,37],queri:[33,34,35],querytest:31,question:13,quickli:13,r:[6,8],random:[27,36],random_str:27,rang:[29,36],re:13,read:[17,18,36],read_lin:18,readi:[13,37],readili:13,readm:36,realli:13,receiv:25,receiver_list:25,red:18,redund:30,refer:[0,8,33,34,35],referenc:0,rel:[14,35],relat:13,remov:[0,6,7,14,35],replac:27,repo:13,repositori:13,repres:[18,19,23,25],represent:[20,21,22,24,25,26],reproduc:13,reproduct:13,requir:13,requiredarg:6,reserv:13,reset:[18,27],reset_cursor_posit:18,reset_execut:27,restart:[6,9,37],result:[25,27,30],revers:30,right:13,rm:13,root:6,run:[1,5,16,18,27,30,36,37],runtest:31,runtim:23,runtime_directori:23,s:[6,9,13,32,35],same:6,sampl:36,save:[13,17,21],save_chang:21,scenario:13,schemat:[14,35],schreibtisch:[20,21],scope:22,search:[13,17,22],search_typ:17,section:36,see:[5,13,20,21,36,37],select:[18,30,36],send:[13,25],send_mail:25,serv:6,server:[6,25,33,34,37],servic:[2,16,22,24,25,36],service_collect:[15,35],service_collection_abc:[15,16,35],service_descriptor:[15,35],service_lifetime_enum:[15,35],service_provid:[15,35],service_provider_abc:[15,16,35],service_typ:22,servicecollect:22,servicecollectionabc:[16,22],servicedescriptor:22,servicelifetimeenum:22,serviceprovid:22,serviceproviderabc:[16,22],session:[20,21],set:[2,16,17,18,19,22,23,24,25,26,27,31,32,35,36],set_background_color:18,set_cursor_posit:18,set_execut:27,set_foreground_color:18,set_hold_back:18,set_runtime_directori:23,set_working_directori:23,setup:[6,7,31,34,37],sh:[13,37],sh_cpl:[13,20,21,37],should:[17,36,37],show:[3,18],shown:[6,17,37],significantli:13,similar:37,simpl:[5,33,34,37],singl:30,single_or_default:30,singleton:22,site:[20,21],size:13,skip:30,skip_last:30,small:13,snake:27,snake_cas:27,so:[13,37],some:6,sometim:13,soon:13,sort:30,sourc:[0,1,7,13,27,36,37],specifi:[0,6,8,17],spinner:18,spinner_background_color:18,spinner_foreground_color:18,spinner_thread:[15,35],spinnerthread:18,sqlalchemi:[20,21],src:36,stage:23,standard:27,start:[6,14,31,33,34,35],start_tim:23,startup:16,startup_abc:[15,35],startupabc:16,statement:6,stderr:27,stdout:27,step:13,stop:18,stop_spin:18,store:17,str:[0,1,2,3,4,5,7,8,10,17,18,19,20,21,23,24,25,26,27,36],street:31,string:[15,18,20,21,24,25,35,36],style:13,subject:25,submodul:[15,35],subprocess:27,success:37,successfulli:13,sum:30,suppli:6,sure:13,sven:[20,21],syntax:[14,35],system:27,t:[13,30,36],tabl:[14,18,27,32,35],take:[6,17,30],take_last:30,target:[0,1],tb:18,team:13,termin:[6,18,36,37],test:[13,23,36],test_al:31,test_ani:31,test_append:31,test_avg:31,test_contain:31,test_count:31,test_distinct:31,test_element_at:31,test_element_at_or_default:31,test_first:31,test_first_or_default:31,test_for_each:31,test_last:31,test_last_or_default:31,test_max:31,test_min:31,test_order_bi:31,test_order_by_descend:31,test_revers:31,test_singl:31,test_single_or_default:31,test_skip:31,test_skip_last:31,test_sum:31,test_tak:31,test_take_last:31,test_then_bi:31,test_then_by_descend:31,test_wher:31,testcas:31,text:18,text_background_color:18,text_foreground_color:18,than:[13,30],thank:13,them:1,themselv:13,then_bi:30,then_by_descend:30,thi:[3,13,16,33,34,36,37],those:37,thread:[2,18],through:36,throughout:13,thrown:24,time:[13,15,24,35],time_format:[24,26],time_format_set:[15,24,35],time_format_settings_names_enum:[15,35],timeformat:26,timeformatset:[24,26],timeformatsettingsnamesenum:26,to_list:[17,30],todai:13,token:17,topic:13,trace:24,traceback:18,tracker:13,transceiv:25,tree:24,tutori:[36,37],type:[0,1,2,3,4,7,8,10,14,16,17,22,29,30,35],u:[6,11],ui:[6,10],ultim:13,under:13,understand:[13,33,34,36,37],unexpect:29,unfortun:13,uninstal:[6,14,27,35],union:[17,18,22,30],unit:13,unittest:31,up:[31,32,35],updat:[6,13,14,35],upfront:13,upper:[27,36],url:[27,37],us:[0,1,6,7,8,13,16,18,25,27,33,34,36,37],use_extens:16,use_startup:16,user:[31,36],user_nam:25,usernam:25,util:[15,35],v:[6,12],valid:[25,36],valu:[0,1,2,3,4,5,7,8,10,17,18,19,22,23,24,25,26,29,30],value_token:17,variabl:[17,27],ve:36,version:[6,14,35],via:[4,10,13],vs:36,wa:[17,37],walk:36,want:[13,36],warn:24,watch:37,we:[13,36],wealth:13,welcom:36,well:13,what:[32,35],when:[18,29,30],where:30,whether:17,which:[0,6,17,18,27,37],white:18,who:13,window:37,within:[1,6,13],without:[4,6,13,30],work:[6,13,23],workaround:13,workflow:[14,35],working_directori:23,workspac:[0,1,5,6,8,32,35],world:[36,37],would:13,write:[13,18,24],write_at:18,write_lin:[18,36],write_line_at:18,wrongtypeexcept:29,x:18,y:[18,36],yellow:18,you:[0,1,6,8,13,33,34,36,37],your:[4,6,9,13,33,34,37]},titles:["cpl add","cpl build","cpl generate","cpl help","cpl install","cpl new","CLI Overview and Command Reference","cpl publish","cpl remove","cpl start","cpl uninstall","cpl update","cpl version","Contributing to CPL","CLI Reference","API Reference","cpl_core.application","cpl_core.configuration","cpl_core.console","cpl_core.database","cpl_core.database.connection","cpl_core.database.context","cpl_core.dependency_injection","cpl_core.environment","cpl_core.logging","cpl_core.mailing","cpl_core.time","cpl_core.utils","Query Reference","cpl_query.exceptions","cpl_query.extension","cpl_query.tests package","Getting started","Introduction to the CPL Docs","Introduction to the CPL Docs","cpl","Getting started with CPL","Setting up the local environment and workspace"],titleterms:{"new":5,add:0,address:13,an:13,api:15,app:37,applic:16,application_abc:16,application_build:16,application_builder_abc:16,application_environ:23,application_environment_abc:23,argument:[0,2,3,4,8,10],background_color_enum:18,basic:6,bug:13,build:1,cli:[6,14,37],code:13,command:6,configur:17,configuration_abc:17,configuration_model_abc:17,configuration_variable_name_enum:17,connect:20,consol:[18,37],console_argu:17,console_cal:18,content:[0,1,2,4,5,6,7,8,10,31,36,37],context:21,contribut:13,cpl:[0,1,2,3,4,5,7,8,9,10,11,12,13,33,34,35,36],cpl_core:[16,17,18,19,20,21,22,23,24,25,26,27],cpl_queri:[29,30,31],creat:[36,37],credential_manag:27,databas:[19,20,21],database_connect:20,database_connection_abc:20,database_context:21,database_context_abc:21,database_model:19,database_set:19,database_settings_name_enum:19,dependency_inject:22,descript:[0,1,2,3,4,5,7,8,10],doc:[33,34],email:25,email_client_abc:25,email_client_servic:25,email_client_set:25,email_client_settings_name_enum:25,environ:[23,37],environment_name_enum:23,except:29,explor:34,extens:30,featur:13,feedback:13,foreground_color_enum:18,found:13,gener:2,get:[32,36],guidelin:13,help:3,initi:37,instal:[4,37],introduct:[33,34],issu:13,iter:30,iterable_abc:30,iterable_test:31,languag:6,librari:37,licens:13,list:30,local:37,log:24,logger_abc:24,logger_servic:24,logging_level_enum:24,logging_set:24,logging_settings_name_enum:24,mail:25,manual:33,menu:36,model:31,modul:31,next:[36,37],ordered_iter:30,ordered_iterable_abc:30,overview:6,packag:[31,37],path:6,pip:27,prerequisit:[36,37],project:[5,36],publish:7,pull:13,queri:28,query_test:31,refer:[6,14,15,28],rel:6,remov:8,request:13,review:13,rule:13,s:[36,37],schemat:[2,6],service_collect:22,service_collection_abc:22,service_descriptor:22,service_lifetime_enum:22,service_provid:22,service_provider_abc:22,set:37,spinner_thread:18,start:[9,32,36,37],startup_abc:16,string:27,submiss:13,submit:13,submodul:[19,31],syntax:6,tabl:[6,36,37],test:31,tester:31,time:26,time_format_set:26,time_format_settings_names_enum:26,type:5,uninstal:10,up:37,updat:11,util:27,version:12,what:[36,37],workflow:6,workspac:37}})
\ No newline at end of file
diff --git a/docs/source/cpl_query.extension.rst b/docs/source/cpl_query.extension.rst
index 3f995913..9dfaa401 100644
--- a/docs/source/cpl_query.extension.rst
+++ b/docs/source/cpl_query.extension.rst
@@ -8,6 +8,14 @@ cpl_query.extension.iterable_abc
:members:
:undoc-members:
:show-inheritance:
+
+cpl_query.extension.iterable
+----------------------------------------------------
+
+.. automodule:: cpl_query.extension.iterable
+ :members:
+ :undoc-members:
+ :show-inheritance:
cpl_query.extension.list
----------------------------------------------------
@@ -21,6 +29,14 @@ cpl_query.extension.ordered_iterable_abc
----------------------------------------------------
.. automodule:: cpl_query.extension.ordered_iterable_abc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+cpl_query.extension.ordered_iterable
+----------------------------------------------------
+
+.. automodule:: cpl_query.extension.ordered_iterable
:members:
:undoc-members:
:show-inheritance:
\ No newline at end of file
diff --git a/src/cpl_query/extension/iterable_abc.py b/src/cpl_query/extension/iterable_abc.py
index f10547f6..e04a4ce5 100644
--- a/src/cpl_query/extension/iterable_abc.py
+++ b/src/cpl_query/extension/iterable_abc.py
@@ -3,6 +3,8 @@ from typing import Optional, Callable, Union, Iterable
class IterableABC(ABC, list):
+ r"""ABC to define functions on list
+ """
@abstractmethod
def __init__(self, t: type = None, values: list = None):
@@ -21,12 +23,43 @@ class IterableABC(ABC, list):
return self._type
@abstractmethod
- def any(self, func: Callable) -> bool: pass
+ def all(self, func: Callable) -> bool:
+ r"""Checks if every element of list equals result found by function
+
+ Parameter
+ ---------
+ func: :class:`Callable`
+ selected value
+
+ Returns
+ -------
+ bool
+ """
+ pass
@abstractmethod
- def all(self, func: Callable) -> bool: pass
+ def any(self, func: Callable) -> bool:
+ r"""Checks if list contains result found by function
+
+ Parameter
+ ---------
+ func: :class:`Callable`
+ selected value
+
+ Returns
+ -------
+ bool
+ """
+ pass
def append(self, __object: object) -> None:
+ r"""Adds element to list
+
+ Parameter
+ ---------
+ __object: :class:`object`
+ value
+ """
if self._type is not None and type(__object) != self._type and not isinstance(type(__object), self._type) \
and not issubclass(type(__object), self._type):
raise Exception(f'Unexpected type: {type(__object)}')
@@ -37,80 +70,347 @@ class IterableABC(ABC, list):
super().append(__object)
@abstractmethod
- def average(self, func: Callable = None) -> Union[int, float, complex]: pass
+ def average(self, func: Callable = None) -> Union[int, float, complex]:
+ r"""Returns average value of list
+
+ Parameter
+ ---------
+ func: :class:`Callable`
+ selected value
+
+ Returns
+ -------
+ Union[int, float, complex]
+ """
+ pass
@abstractmethod
- def contains(self, value: object) -> bool: pass
+ def contains(self, value: object) -> bool:
+ r"""Checks if list contains value given by function
+
+ Parameter
+ ---------
+ value: :class:`object`
+ value
+
+ Returns
+ -------
+ bool
+ """
+ pass
@abstractmethod
- def count(self, func: Callable) -> int: pass
+ def count(self, func: Callable) -> int:
+ r"""Returns length of list or count of found elements
+
+ Parameter
+ ---------
+ func: :class:`Callable`
+ selected value
+
+ Returns
+ -------
+ int
+ """
+ pass
@abstractmethod
- def distinct(self, func: Callable) -> 'IterableABC': pass
+ def distinct(self, func: Callable) -> 'IterableABC':
+ r"""Returns list without redundancies
+
+ Parameter
+ ---------
+ func: :class:`Callable`
+ selected value
+
+ Returns
+ -------
+ :class: `cpl_query.extension.iterable_abc.IterableABC`
+ """
+ pass
@abstractmethod
- def element_at(self, index: int) -> any: pass
+ def element_at(self, index: int) -> any:
+ r"""Returns element at given index
+
+ Parameter
+ ---------
+ index: :class:`int`
+ index
+
+ Returns
+ -------
+ Value at index: any
+ """
+ pass
@abstractmethod
- def element_at_or_default(self, index: int) -> Optional[any]: pass
+ def element_at_or_default(self, index: int) -> Optional[any]:
+ r"""Returns element at given index or None
+
+ Parameter
+ ---------
+ index: :class:`int`
+ index
+
+ Returns
+ -------
+ Value at index: Optional[any]
+ """
+ pass
def extend(self, __iterable: Iterable) -> None:
+ r"""Adds elements of given list to list
+
+ Parameter
+ ---------
+ __iterable: :class: `cpl_query.extension.iterable.Iterable`
+ index
+ """
for value in __iterable:
self.append(value)
@abstractmethod
- def last(self) -> any: pass
+ def last(self) -> any:
+ r"""Returns last element
+
+ Returns
+ -------
+ Last element of list: any
+ """
+ pass
@abstractmethod
- def last_or_default(self) -> any: pass
+ def last_or_default(self) -> any:
+ r"""Returns last element or None
+
+ Returns
+ -------
+ Last element of list: Optional[any]
+ """
+ pass
@abstractmethod
- def first(self) -> any: pass
+ def first(self) -> any:
+ r"""Returns first element
+
+ Returns
+ -------
+ First element of list: any
+ """
+ pass
@abstractmethod
- def first_or_default(self) -> any: pass
+ def first_or_default(self) -> any:
+ r"""Returns first element or None
+
+ Returns
+ -------
+ First element of list: Optional[any]
+ """
+ pass
@abstractmethod
- def for_each(self, func: Callable) -> Union[int, float, complex]: pass
+ def for_each(self, func: Callable):
+ r"""Runs given function for each element of list
+
+ Parameter
+ ---------
+ func: :class: `Callable`
+ function to call
+ """
+ pass
@abstractmethod
- def max(self, func: Callable = None) -> Union[int, float, complex]: pass
+ def max(self, func: Callable = None) -> Union[int, float, complex]:
+ r"""Returns highest value
+
+ Parameter
+ ---------
+ func: :class:`Callable`
+ selected value
+
+ Returns
+ -------
+ Union[int, float, complex]
+ """
+ pass
@abstractmethod
- def min(self, func: Callable = None) -> Union[int, float, complex]: pass
+ def min(self, func: Callable = None) -> Union[int, float, complex]:
+ r"""Returns highest value
+
+ Parameter
+ ---------
+ func: :class:`Callable`
+ selected value
+
+ Returns
+ -------
+ Union[int, float, complex]
+ """
+ pass
@abstractmethod
- def order_by(self, func: Callable) -> 'IterableABC': pass
+ def order_by(self, func: Callable) -> 'IterableABC':
+ r"""Sorts elements by function in ascending order
+
+ Parameter
+ ---------
+ func: :class:`Callable`
+ selected value
+
+ Returns
+ -------
+ :class: `cpl_query.extension.iterable_abc.IterableABC`
+ """
+ pass
@abstractmethod
- def order_by_descending(self, func: Callable) -> 'IterableABC': pass
+ def order_by_descending(self, func: Callable) -> 'IterableABC':
+ r"""Sorts elements by function in descending order
+
+ Parameter
+ ---------
+ func: :class:`Callable`
+ selected value
+
+ Returns
+ -------
+ :class: `cpl_query.extension.iterable_abc.IterableABC`
+ """
+ pass
@abstractmethod
- def reverse(self) -> 'IterableABC': pass
+ def reverse(self) -> 'IterableABC':
+ r"""Reverses list
+
+ Returns
+ -------
+ :class: `cpl_query.extension.iterable_abc.IterableABC`
+ """
+ pass
@abstractmethod
- def single(self) -> any: pass
+ def single(self) -> any:
+ r"""Returns one single element of list
+
+ Returns
+ -------
+ Found value: any
+
+ Raises
+ ------
+ ArgumentNoneException: when argument is None
+ Exception: when argument is None or found more than one element
+ """
+ pass
@abstractmethod
- def single_or_default(self) -> Optional[any]: pass
+ def single_or_default(self) -> Optional[any]:
+ r"""Returns one single element of list
+
+ Returns
+ -------
+ Found value: Optional[any]
+ """
+ pass
@abstractmethod
- def skip(self, index: int) -> 'IterableABC': pass
+ def skip(self, index: int) -> 'IterableABC':
+ r"""Skips all elements from index
+
+ Parameter
+ ---------
+ index: :class:`int`
+ index
+
+ Returns
+ -------
+ :class: `cpl_query.extension.iterable_abc.IterableABC`
+ """
+ pass
@abstractmethod
- def skip_last(self, index: int) -> 'IterableABC': pass
+ def skip_last(self, index: int) -> 'IterableABC':
+ r"""Skips all elements after index
+
+ Parameter
+ ---------
+ index: :class:`int`
+ index
+
+ Returns
+ -------
+ :class: `cpl_query.extension.iterable_abc.IterableABC`
+ """
+ pass
@abstractmethod
- def sum(self, func: Callable = None) -> Union[int, float, complex]: pass
+ def sum(self, func: Callable = None) -> Union[int, float, complex]:
+ r"""Sum of all values
+
+ Parameter
+ ---------
+ func: :class:`Callable`
+ selected value
+
+ Returns
+ -------
+ Union[int, float, complex]
+ """
+ pass
@abstractmethod
- def take(self, index: int) -> 'IterableABC': pass
+ def take(self, index: int) -> 'IterableABC':
+ r"""Takes all elements from index
+
+ Parameter
+ ---------
+ index: :class:`int`
+ index
+
+ Returns
+ -------
+ :class: `cpl_query.extension.iterable_abc.IterableABC`
+ """
+ pass
@abstractmethod
- def take_last(self, index: int) -> 'IterableABC': pass
+ def take_last(self, index: int) -> 'IterableABC':
+ r"""Takes all elements after index
+
+ Parameter
+ ---------
+ index: :class:`int`
+ index
+
+ Returns
+ -------
+ :class: `cpl_query.extension.iterable_abc.IterableABC`
+ """
+ pass
def to_list(self) -> list:
+ r"""Converts :class: `cpl_query.extension.iterable_abc.IterableABC` to :class: `list`
+
+ Returns
+ -------
+ :class: `list`
+ """
return list(self)
@abstractmethod
- def where(self, func: Callable) -> 'IterableABC': pass
+ def where(self, func: Callable) -> 'IterableABC':
+ r"""Select element by function
+
+ Parameter
+ ---------
+ func: :class:`Callable`
+ selected value
+
+ Returns
+ -------
+ :class: `cpl_query.extension.iterable_abc.IterableABC`
+ """
+ pass
|