Compare commits
	
		
			186 Commits
		
	
	
		
			2021.4.0.p
			...
			7a65dbe39b
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 7a65dbe39b | |||
| f83755ac77 | |||
| a590cfd066 | |||
| f317035342 | |||
| 8900bdd446 | |||
| 35ecf158a2 | |||
| 353c1d30ec | |||
| 1c94fb5bd1 | |||
| cf305aeebb | |||
| 90e97433e0 | |||
| 125a85a0af | |||
| cfb8838c73 | |||
| 824d491ebc | |||
| d694c408c0 | |||
| d1bb266d49 | |||
| 419fcc3d29 | |||
| 24ab6a51c1 | |||
| dec4a45d98 | |||
| d11c56db03 | |||
| fc23315cc7 | |||
| 1f503fe20d | |||
| 4564f7ac0e | |||
| 7b823e1141 | |||
| dac3d9c6bb | |||
| ccca904cb8 | |||
| c66a81c0ec | |||
| fb810e2943 | |||
| 5cc663dedc | |||
| 593372699b | |||
| 1899cb5b86 | |||
| 0a285f2d28 | |||
| 94c82e6701 | |||
| 0d37c86061 | |||
| 6c8e9ccd89 | |||
| e7cf545502 | |||
| 44182eec86 | |||
| 0f5b1b7586 | |||
| 4fe073580a | |||
| 2fed654c16 | |||
| 8ebd4864d3 | |||
| a495532a4d | |||
| d87ce72f07 | |||
| 50201346e2 | |||
| 773b154371 | |||
| 5b59d1d384 | |||
| dcd8583183 | |||
| 97e52b39c0 | |||
| 581013b61a | |||
| fd68d25a1d | |||
| 588f93f7b1 | |||
| 96f402dcdd | |||
| c1b7fca8d5 | |||
| 2e4e7ccc57 | |||
| ada3d133df | |||
| 61e7b9d684 | |||
| 24172c658c | |||
| 62ac976b99 | |||
| 1f445a99b2 | |||
| 025286052b | |||
| 32a856f8e8 | |||
| 21f50f3b24 | |||
| ce77d41246 | |||
| dec137220c | |||
| 01c7e155c3 | |||
| dcbcb67ce8 | |||
| d57fd10718 | |||
| 2b91db5d81 | |||
| dffa3de1ec | |||
| 403837901b | |||
| 0de725c907 | |||
| e811e08c52 | |||
| 6518ae7516 | |||
| 95b5f99f1f | |||
| de22e79b71 | |||
| 127c67e566 | |||
| 3523dbd5c5 | |||
| b526a07e19 | |||
| d9f10edbb7 | |||
| 7616cd4c69 | |||
| afe75f6848 | |||
| c0e2db8281 | |||
| 3727af11c4 | |||
| 450295cfcf | |||
| 457bce8aa9 | |||
| 0f81497ea3 | |||
| fa7ee800e1 | |||
| 56b7452e55 | |||
| 9d73566453 | |||
| 28ba0c174a | |||
| 5d0444bcc0 | |||
| 40876005d5 | |||
| ac6d941822 | |||
| 113b365a47 | |||
| 2f785536e1 | |||
| 9ab4013b4b | |||
| b3b04f03ce | |||
| 57040f85f0 | |||
| 589ef4fd4c | |||
| 4b829cc484 | |||
| 98e343a108 | |||
| 7749d5a789 | |||
| c3b48bfa41 | |||
| 470e7ab2f4 | |||
| 4ceea36926 | |||
| b3f8174663 | |||
| 58dccea28b | |||
| ca086e01d7 | |||
| c5b1a95661 | |||
| d7881774a8 | |||
| 6eec92243e | |||
| 124b236182 | |||
| 2dc96cdf3d | |||
| 6f7923debc | |||
| 90d148b4a5 | |||
| 73e2c5ec10 | |||
| f31522dcd9 | |||
| a83607fd81 | |||
| 707df3f27d | |||
| 0f43e57831 | |||
| c08ab33060 | |||
| ee2abd98b3 | |||
| e39661a42a | |||
| 9518d19580 | |||
| adf95faaf8 | |||
| 2f92e9909d | |||
| b18f2c4bcd | |||
| 784ba049ad | |||
| 4d6d19d2e5 | |||
| 6fa47f19af | |||
| fb2872422e | |||
| 8460c0fa33 | |||
| 18f95341f4 | |||
| a8011267d9 | |||
| f8ebb4f1d7 | |||
| 3903f85368 | |||
| 05a9bdbf4a | |||
| 2809a9cd82 | |||
| 1c6794dc40 | |||
| cac80657df | |||
| 11241d8f99 | |||
| 308e5c9b0c | |||
| c12ff4f9e3 | |||
| 091c89df2c | |||
| 63a67be0ee | |||
| c68224b31a | |||
| 9f219757c3 | |||
| e09a4402b3 | |||
| 6867eb0e65 | |||
| ffaa5c4a2b | |||
| b9499108d8 | |||
| 37175b7227 | |||
| 2b5831c5fe | |||
| 62c8b9c68d | |||
| a080119c44 | |||
| a26c6f1bd9 | |||
| daac14e099 | |||
| d4b5c32a21 | |||
| c115afd736 | |||
| e7863a92e0 | |||
| 82a9e3a23a | |||
| a3a0a150a8 | |||
| 6951a19670 | |||
| 669133d491 | |||
| c60598b3f6 | |||
| 45733b30ef | |||
| f8bd86692e | |||
| 5e5d86cf94 | |||
| e0b7728719 | |||
| 0f85d4b9bc | |||
| a3fff9c7d7 | |||
| 8dcf3a6768 | |||
| 94949394de | |||
| b7be439381 | |||
| 0cae3428b9 | |||
| cc7755bafc | |||
| 4e78b9c12b | |||
| 5c80cf2222 | |||
| d02548e1a8 | |||
| 51efe973e8 | |||
| 0bb272d89b | |||
| 59f6843ea9 | |||
| be6838f97b | |||
| d5b2d3605b | |||
| 7a48917fb4 | |||
| 59832742b6 | |||
| f9f04901c0 | 
							
								
								
									
										3
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							| @@ -106,6 +106,7 @@ celerybeat.pid | |||||||
| .venv | .venv | ||||||
| env/ | env/ | ||||||
| venv/ | venv/ | ||||||
|  | venv_*/ | ||||||
| ENV/ | ENV/ | ||||||
| env.bak/ | env.bak/ | ||||||
| venv.bak/ | venv.bak/ | ||||||
| @@ -132,5 +133,5 @@ dmypy.json | |||||||
| .pyre/ | .pyre/ | ||||||
|  |  | ||||||
| # IDE | # IDE | ||||||
| .vscode/ |  | ||||||
| .idea/ | .idea/ | ||||||
|  | PythonImportHelper-v2-Completion.json | ||||||
|   | |||||||
							
								
								
									
										307
									
								
								.vscode/launch.json
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										307
									
								
								.vscode/launch.json
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,307 @@ | |||||||
|  | { | ||||||
|  |     // Use IntelliSense to learn about possible attributes. | ||||||
|  |     // Hover to view descriptions of existing attributes. | ||||||
|  |     // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 | ||||||
|  |     "version": "0.2.0", | ||||||
|  |     "configurations": [ | ||||||
|  |         { | ||||||
|  |             "name": "Python: Aktuelle Datei", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "program": "${file}", | ||||||
|  |             "console": "integratedTerminal" | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CPL: main test", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}/cpl_core/src/tests/custom/general/src/general", | ||||||
|  |             "program": "main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "--customer=sh-edraft.de" | ||||||
|  |             ], | ||||||
|  |             "env": { | ||||||
|  |                 "CPL_NAME": "CPL_Dev_Test", | ||||||
|  |                 "PYTHON_ENVIRONMENT": "development" | ||||||
|  |             } | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CPL: console test", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}/src/tests/custom/console", | ||||||
|  |             "program": "main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CPL: database test", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}/src/tests/custom/database/src", | ||||||
|  |             "program": "main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "env": { | ||||||
|  |                 "PYTHON_ENVIRONMENT": "development", | ||||||
|  |                 "PYTHONPATH": "${workspaceFolder}/src/:$PYTHONPATH" | ||||||
|  |             } | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}/", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [] | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: add", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}/src/tests/custom/general", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "add", | ||||||
|  |                 "testing", | ||||||
|  |                 "general", | ||||||
|  |             ] | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: remove", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}/src/tests/custom/general", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "remove", | ||||||
|  |                 "testing", | ||||||
|  |             ] | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: build", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "build" | ||||||
|  |             ] | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: generate abc", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "generate", | ||||||
|  |                 "a", | ||||||
|  |                 "testName" | ||||||
|  |             ] | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: generate class", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "generate", | ||||||
|  |                 "c", | ||||||
|  |                 "src/hfs/fsnfiu/fiush/fisbf/testName" | ||||||
|  |             ] | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: generate enum", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "generate", | ||||||
|  |                 "e", | ||||||
|  |                 "testName" | ||||||
|  |             ] | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: generate service", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "generate", | ||||||
|  |                 "s", | ||||||
|  |                 "testName" | ||||||
|  |             ] | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: generate settings", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "generate", | ||||||
|  |                 "st", | ||||||
|  |                 "testName" | ||||||
|  |             ] | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: generate thread", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "generate", | ||||||
|  |                 "t", | ||||||
|  |                 "testName" | ||||||
|  |             ] | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: hello-world", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "hello-world", | ||||||
|  |             ] | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: help", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "help", | ||||||
|  |             ] | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: install discord.py", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}/src/tests/custom/general", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "install", | ||||||
|  |                 "discord.py", | ||||||
|  |             ], | ||||||
|  |             "env": { | ||||||
|  |                 "GISMO_ENVIRONMENT": "development", | ||||||
|  |                 "PYTHONPATH": "${workspaceFolder}/src/:$PYTHONPATH" | ||||||
|  |             } | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: install local", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}/src/tests/custom/general", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "install", | ||||||
|  |             ] | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: new console", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "new", | ||||||
|  |                 "console", | ||||||
|  |                 "HelloWorld" | ||||||
|  |             ] | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: new library", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "new", | ||||||
|  |                 "library", | ||||||
|  |                 "HelloWorldLib" | ||||||
|  |             ] | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: publish", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "publish", | ||||||
|  |             ] | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: start", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "start", | ||||||
|  |             ], | ||||||
|  |             "env": { | ||||||
|  |                 "PYTHONPATH": "${workspaceFolder}/src/:${workspaceFolder}/src/cpl_cli/" | ||||||
|  |             } | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: uninstall discord.py", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}/src/tests/custom/general", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "uninstall", | ||||||
|  |                 "discord.py", | ||||||
|  |             ] | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: start", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}/src/tests/custom/general", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "update", | ||||||
|  |             ] | ||||||
|  |         }, | ||||||
|  |         { | ||||||
|  |             "name": "CLI: version", | ||||||
|  |             "type": "python", | ||||||
|  |             "request": "launch", | ||||||
|  |             "cwd": "${workspaceFolder}", | ||||||
|  |             "program": "${workspaceFolder}/src/cpl_cli/main.py", | ||||||
|  |             "console": "integratedTerminal", | ||||||
|  |             "args": [ | ||||||
|  |                 "version", | ||||||
|  |             ] | ||||||
|  |         }, | ||||||
|  |     ] | ||||||
|  | } | ||||||
							
								
								
									
										23
									
								
								.vscode/settings.json
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										23
									
								
								.vscode/settings.json
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,23 @@ | |||||||
|  | { | ||||||
|  |     "workbench.colorCustomizations": { | ||||||
|  |         "activityBar.activeBackground": "#93e6fc", | ||||||
|  |         "activityBar.activeBorder": "#fa45d4", | ||||||
|  |         "activityBar.background": "#93e6fc", | ||||||
|  |         "activityBar.foreground": "#15202b", | ||||||
|  |         "activityBar.inactiveForeground": "#15202b99", | ||||||
|  |         "activityBarBadge.background": "#fa45d4", | ||||||
|  |         "activityBarBadge.foreground": "#15202b", | ||||||
|  |         "sash.hoverBorder": "#93e6fc", | ||||||
|  |         "statusBar.background": "#61dafb", | ||||||
|  |         "statusBar.foreground": "#15202b", | ||||||
|  |         "statusBarItem.hoverBackground": "#2fcefa", | ||||||
|  |         "statusBarItem.remoteBackground": "#61dafb", | ||||||
|  |         "statusBarItem.remoteForeground": "#15202b", | ||||||
|  |         "titleBar.activeBackground": "#61dafb", | ||||||
|  |         "titleBar.activeForeground": "#15202b", | ||||||
|  |         "titleBar.inactiveBackground": "#61dafb99", | ||||||
|  |         "titleBar.inactiveForeground": "#15202b99" | ||||||
|  |     }, | ||||||
|  |     "peacock.color": "#61dafb", | ||||||
|  |     "python.pythonPath": "cpl-env/bin/python3.9", | ||||||
|  | } | ||||||
							
								
								
									
										2
									
								
								LICENSE
									
									
									
									
									
								
							
							
						
						
									
										2
									
								
								LICENSE
									
									
									
									
									
								
							| @@ -1,4 +1,4 @@ | |||||||
| MIT License Copyright (c) 2020 - 2021 sh-edraft.de | MIT License Copyright (c) 2020 - 2022 sh-edraft.de | ||||||
|  |  | ||||||
| Permission is hereby granted, free of charge, to any person obtaining a copy | Permission is hereby granted, free of charge, to any person obtaining a copy | ||||||
| of this software and associated documentation files (the "Software"), to deal | of this software and associated documentation files (the "Software"), to deal | ||||||
|   | |||||||
| @@ -2,8 +2,70 @@ | |||||||
|   "WorkspaceSettings": { |   "WorkspaceSettings": { | ||||||
|     "DefaultProject": "cpl_cli", |     "DefaultProject": "cpl_cli", | ||||||
|     "Projects": { |     "Projects": { | ||||||
|       "cpl": "src/cpl/cpl.json", |       "cpl_core": "src/cpl_core/cpl_core.json", | ||||||
|       "cpl_cli": "src/cpl_cli/cpl_cli.json" |       "cpl_cli": "src/cpl_cli/cpl_cli.json", | ||||||
|  |       "cpl_query": "src/cpl_query/cpl_query.json" | ||||||
|  |     }, | ||||||
|  |     "Scripts": { | ||||||
|  |       "hello-world": "echo 'Hello World'", | ||||||
|  |       "docs-build": "echo 'Build Documentation'; cd docs/; sphinx-apidoc -o source/ ../src/cpl_core; sphinx-apidoc -o source/ ../src/cpl_query; make clean; make html; rm source/cpl_query.tests.rst;", | ||||||
|  |       "db": "cpl build-docs", | ||||||
|  |       "docs-open": "xdg-open $PWD/docs/build/html/index.html &", | ||||||
|  |       "do": "cpl docs-open", | ||||||
|  |  | ||||||
|  |       "build-all": "cpl build-cli; cpl build-core; cpl build-query;", | ||||||
|  |       "ba": "cpl build-all", | ||||||
|  |       "build-cli": "echo 'Build cpl_cli'; cd ./src/cpl_cli; cpl build; cd ../../;", | ||||||
|  |       "build-core": "echo 'Build cpl_core'; cd ./src/cpl_core; cpl build; cd ../../;", | ||||||
|  |       "build-query": "echo 'Build cpl_query'; cd ./src/cpl_query; cpl build; cd ../../;", | ||||||
|  |  | ||||||
|  |       "publish-all": "cpl publish-cli; cpl publish-core; cpl publish-query;", | ||||||
|  |       "pa": "cpl build-all", | ||||||
|  |       "publish-cli": "echo 'Publish cpl_cli'; cd ./src/cpl_cli; cpl publish; cd ../../;", | ||||||
|  |       "publish-core": "echo 'Publish cpl_core'; cd ./src/cpl_core; cpl publish; cd ../../;", | ||||||
|  |       "publish-query": "echo 'Publish cpl_query'; cd ./src/cpl_query; cpl publish; cd ../../;", | ||||||
|  |  | ||||||
|  |       "upload-prod-cli": "echo 'PROD Upload cpl_cli'; cpl upl-prod-cli;", | ||||||
|  |       "upload-prod-core": "echo 'PROD Upload cpl_core'; cpl upl-prod-core;", | ||||||
|  |       "upload-prod-query": "echo 'PROD Upload cpl_query'; cpl upl-prod-query;", | ||||||
|  |  | ||||||
|  |       "upload-exp-cli": "echo 'EXP Upload cpl_cli'; cpl upl-exp-cli;", | ||||||
|  |       "upload-exp-core": "echo 'EXP Upload cpl_core'; cpl upl-exp-core;", | ||||||
|  |       "upload-exp-query": "echo 'EXP Upload cpl_query'; cpl upl-exp-query;", | ||||||
|  |  | ||||||
|  |       "upload-dev-cli": "echo 'DEV Upload cpl_cli'; cpl upl-dev-cli;", | ||||||
|  |       "upload-dev-core": "echo 'DEV Upload cpl_core'; cpl upl-dev-core;", | ||||||
|  |       "upload-dev-query": "echo 'DEV Upload cpl_query'; cpl upl-dev-query;", | ||||||
|  |  | ||||||
|  |       "upl-prod-cli": "twine upload -r pip.sh-edraft.de dist/cpl-cli/publish/setup/*", | ||||||
|  |       "upl-prod-core": "twine upload -r pip.sh-edraft.de dist/cpl-core/publish/setup/*", | ||||||
|  |       "upl-prod-query": "twine upload -r pip.sh-edraft.de dist/cpl-query/publish/setup/*", | ||||||
|  |  | ||||||
|  |       "upl-exp-cli": "twine upload -r pip-exp.sh-edraft.de dist/cpl-cli/publish/setup/*", | ||||||
|  |       "upl-exp-core": "twine upload -r pip-exp.sh-edraft.de dist/cpl-core/publish/setup/*", | ||||||
|  |       "upl-exp-query": "twine upload -r pip-exp.sh-edraft.de dist/cpl-query/publish/setup/*", | ||||||
|  |  | ||||||
|  |       "upl-dev-cli": "twine upload -r pip-dev.sh-edraft.de dist/cpl-cli/publish/setup/*", | ||||||
|  |       "upl-dev-core": "twine upload -r pip-dev.sh-edraft.de dist/cpl-core/publish/setup/*", | ||||||
|  |       "upl-dev-query": "twine upload -r pip-dev.sh-edraft.de dist/cpl-query/publish/setup/*", | ||||||
|  |  | ||||||
|  |       "deploy-prod": "cpl deploy-prod-cli; cpl deploy-prod-core; cpl deploy-prod-query;", | ||||||
|  |       "dp": "cpl deploy-prod", | ||||||
|  |       "deploy-prod-cli": "cpl publish-cli; cpl upload-prod-cli", | ||||||
|  |       "deploy-prod-core": "cpl publish-core; cpl upload-prod-core", | ||||||
|  |       "deploy-prod-query": "cpl publish-query; cpl upload-prod-query", | ||||||
|  |  | ||||||
|  |       "deploy-exp": "cpl deploy-exp-cli; cpl deploy-exp-core; cpl deploy-exp-query;", | ||||||
|  |       "de": "cpl deploy-exp", | ||||||
|  |       "deploy-exp-cli": "cpl publish-cli; cpl upload-exp-cli", | ||||||
|  |       "deploy-exp-core": "cpl publish-core; cpl upload-exp-core", | ||||||
|  |       "deploy-exp-query": "cpl publish-query; cpl upload-exp-query", | ||||||
|  |  | ||||||
|  |       "deploy-dev": "cpl deploy-dev-cli; cpl deploy-dev-core; cpl deploy-dev-query;", | ||||||
|  |       "dd": "cpl deploy-dev", | ||||||
|  |       "deploy-dev-cli": "cpl publish-cli; cpl upload-dev-cli", | ||||||
|  |       "deploy-dev-core": "cpl publish-core; cpl upload-dev-core", | ||||||
|  |       "deploy-dev-query": "cpl publish-query; cpl upload-dev-query" | ||||||
|     } |     } | ||||||
|   } |   } | ||||||
| } | } | ||||||
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cli.generate.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cli.generate.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cli.publish.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cli.publish.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cli.remove.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cli.remove.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.application.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.application.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.configuration.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.configuration.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.console.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.console.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.database.connection.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.database.connection.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.database.context.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.database.context.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.database.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.database.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.dependency_injection.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.dependency_injection.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.environment.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.environment.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.logging.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.logging.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.mailing.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.mailing.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.time.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.time.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.utils.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl.utils.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.application.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.application.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.configuration.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.configuration.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.console.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.console.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.database.connection.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.database.connection.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.database.context.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.database.context.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.database.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.database.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.dependency_injection.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.dependency_injection.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.environment.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.environment.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.logging.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.logging.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.mailing.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.mailing.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.time.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.time.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.utils.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_core.utils.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_query.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_query.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_query.exceptions.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_query.exceptions.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_query.extension.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_query.extension.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_query.tests.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/cpl_query.tests.doctree
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/environment.pickle
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/environment.pickle
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/index.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/index.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/introduction.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/introduction.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/modules.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/modules.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/quickstart.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/quickstart.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										
											BIN
										
									
								
								docs/build/doctrees/setup.doctree
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/build/doctrees/setup.doctree
									
									
									
									
										vendored
									
									
								
							
										
											Binary file not shown.
										
									
								
							
							
								
								
									
										2
									
								
								docs/build/html/_sources/cli.generate.md.txt
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								docs/build/html/_sources/cli.generate.md.txt
									
									
									
									
										vendored
									
									
								
							| @@ -31,5 +31,5 @@ Generates files based on a schematic. | |||||||
| | ```class```       | Class               | ```<name>``` | | ```class```       | Class               | ```<name>``` | ||||||
| | ```enum```        | Enum class          | ```<name>``` | | ```enum```        | Enum class          | ```<name>``` | ||||||
| | ```service```     | Service class       | ```<name>``` | | ```service```     | Service class       | ```<name>``` | ||||||
| | ```settings```    | [Configmodel](cpl.configuration) | ```<name>``` | | ```settings```    | [Configmodel](cpl_core.configuration) | ```<name>``` | ||||||
| | ```thread```      | Thread class        | ```<name>``` | | ```thread```      | Thread class        | ```<name>``` | ||||||
|   | |||||||
							
								
								
									
										2
									
								
								docs/build/html/_sources/cli.publish.md.txt
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								docs/build/html/_sources/cli.publish.md.txt
									
									
									
									
										vendored
									
									
								
							| @@ -15,7 +15,7 @@ cpl **P** | |||||||
|  |  | ||||||
| The command can be used to publish a project of type "console" or "library". | 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.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. | 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. | Generated files of ```setup.py``` are in the 'publish/setup/' directory. | ||||||
|   | |||||||
							
								
								
									
										7
									
								
								docs/build/html/_sources/cli.remove.md.txt
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										7
									
								
								docs/build/html/_sources/cli.remove.md.txt
									
									
									
									
										vendored
									
									
								
							| @@ -13,12 +13,9 @@ cpl **R** *<project>* | |||||||
|  |  | ||||||
| ## Description | ## Description | ||||||
|  |  | ||||||
| The command can be used to publish a project of type "console" or "library". | Removes a project reference and the files from workspace. | ||||||
|  |  | ||||||
| The publish command builds the source files and then creates an ```setup.py``` with data from ```cpl.json```. | If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified. | ||||||
| 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. |  | ||||||
|  |  | ||||||
| ## Arguments | ## Arguments | ||||||
|  |  | ||||||
|   | |||||||
| @@ -1,42 +0,0 @@ | |||||||
| cpl.configuration |  | ||||||
| ========================= |  | ||||||
|  |  | ||||||
| cpl.configuration.configuration |  | ||||||
| -------------------------------------- |  | ||||||
|  |  | ||||||
| .. automodule:: cpl.configuration.configuration |  | ||||||
|    :members: |  | ||||||
|    :undoc-members: |  | ||||||
|    :show-inheritance: |  | ||||||
|  |  | ||||||
| cpl.configuration.configuration\_abc |  | ||||||
| ------------------------------------------- |  | ||||||
|  |  | ||||||
| .. automodule:: cpl.configuration.configuration_abc |  | ||||||
|    :members: |  | ||||||
|    :undoc-members: |  | ||||||
|    :show-inheritance: |  | ||||||
|  |  | ||||||
| cpl.configuration.configuration\_model\_abc |  | ||||||
| -------------------------------------------------- |  | ||||||
|  |  | ||||||
| .. automodule:: cpl.configuration.configuration_model_abc |  | ||||||
|    :members: |  | ||||||
|    :undoc-members: |  | ||||||
|    :show-inheritance: |  | ||||||
|  |  | ||||||
| cpl.configuration.configuration\_variable\_name\_enum |  | ||||||
| ------------------------------------------------------------ |  | ||||||
|  |  | ||||||
| .. automodule:: cpl.configuration.configuration_variable_name_enum |  | ||||||
|    :members: |  | ||||||
|    :undoc-members: |  | ||||||
|    :show-inheritance: |  | ||||||
|  |  | ||||||
| cpl.configuration.console\_argument |  | ||||||
| ------------------------------------------ |  | ||||||
|  |  | ||||||
| .. automodule:: cpl.configuration.console_argument |  | ||||||
|    :members: |  | ||||||
|    :undoc-members: |  | ||||||
|    :show-inheritance: |  | ||||||
| @@ -1,18 +0,0 @@ | |||||||
| cpl.database.connection |  | ||||||
| =============================== |  | ||||||
|  |  | ||||||
| cpl.database.connection.database\_connection |  | ||||||
| --------------------------------------------------- |  | ||||||
|  |  | ||||||
| .. automodule:: cpl.database.connection.database_connection |  | ||||||
|    :members: |  | ||||||
|    :undoc-members: |  | ||||||
|    :show-inheritance: |  | ||||||
|  |  | ||||||
| cpl.database.connection.database\_connection\_abc |  | ||||||
| -------------------------------------------------------- |  | ||||||
|  |  | ||||||
| .. automodule:: cpl.database.connection.database_connection_abc |  | ||||||
|    :members: |  | ||||||
|    :undoc-members: |  | ||||||
|    :show-inheritance: |  | ||||||
| @@ -1,18 +0,0 @@ | |||||||
| cpl.database.context |  | ||||||
| ============================ |  | ||||||
|  |  | ||||||
| cpl.database.context.database\_context |  | ||||||
| --------------------------------------------- |  | ||||||
|  |  | ||||||
| .. automodule:: cpl.database.context.database_context |  | ||||||
|    :members: |  | ||||||
|    :undoc-members: |  | ||||||
|    :show-inheritance: |  | ||||||
|  |  | ||||||
| cpl.database.context.database\_context\_abc |  | ||||||
| -------------------------------------------------- |  | ||||||
|  |  | ||||||
| .. automodule:: cpl.database.context.database_context_abc |  | ||||||
|    :members: |  | ||||||
|    :undoc-members: |  | ||||||
|    :show-inheritance: |  | ||||||
| @@ -1,50 +0,0 @@ | |||||||
| cpl.dependency\_injection |  | ||||||
| ================================= |  | ||||||
|  |  | ||||||
| cpl.dependency\_injection.service\_collection |  | ||||||
| ---------------------------------------------------- |  | ||||||
|  |  | ||||||
| .. automodule:: cpl.dependency_injection.service_collection |  | ||||||
|    :members: |  | ||||||
|    :undoc-members: |  | ||||||
|    :show-inheritance: |  | ||||||
|  |  | ||||||
| cpl.dependency\_injection.service\_collection\_abc |  | ||||||
| --------------------------------------------------------- |  | ||||||
|  |  | ||||||
| .. automodule:: cpl.dependency_injection.service_collection_abc |  | ||||||
|    :members: |  | ||||||
|    :undoc-members: |  | ||||||
|    :show-inheritance: |  | ||||||
|  |  | ||||||
| cpl.dependency\_injection.service\_descriptor |  | ||||||
| ---------------------------------------------------- |  | ||||||
|  |  | ||||||
| .. automodule:: cpl.dependency_injection.service_descriptor |  | ||||||
|    :members: |  | ||||||
|    :undoc-members: |  | ||||||
|    :show-inheritance: |  | ||||||
|  |  | ||||||
| cpl.dependency\_injection.service\_lifetime\_enum |  | ||||||
| -------------------------------------------------------- |  | ||||||
|  |  | ||||||
| .. automodule:: cpl.dependency_injection.service_lifetime_enum |  | ||||||
|    :members: |  | ||||||
|    :undoc-members: |  | ||||||
|    :show-inheritance: |  | ||||||
|  |  | ||||||
| cpl.dependency\_injection.service\_provider |  | ||||||
| -------------------------------------------------- |  | ||||||
|  |  | ||||||
| .. automodule:: cpl.dependency_injection.service_provider |  | ||||||
|    :members: |  | ||||||
|    :undoc-members: |  | ||||||
|    :show-inheritance: |  | ||||||
|  |  | ||||||
| cpl.dependency\_injection.service\_provider\_abc |  | ||||||
| ------------------------------------------------------- |  | ||||||
|  |  | ||||||
| .. automodule:: cpl.dependency_injection.service_provider_abc |  | ||||||
|    :members: |  | ||||||
|    :undoc-members: |  | ||||||
|    :show-inheritance: |  | ||||||
							
								
								
									
										26
									
								
								docs/build/html/_sources/cpl.environment.rst.txt
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										26
									
								
								docs/build/html/_sources/cpl.environment.rst.txt
									
									
									
									
										vendored
									
									
								
							| @@ -1,26 +0,0 @@ | |||||||
| cpl.environment |  | ||||||
| ======================= |  | ||||||
|  |  | ||||||
| cpl.environment.application\_environment |  | ||||||
| ----------------------------------------------- |  | ||||||
|  |  | ||||||
| .. automodule:: cpl.environment.application_environment |  | ||||||
|    :members: |  | ||||||
|    :undoc-members: |  | ||||||
|    :show-inheritance: |  | ||||||
|  |  | ||||||
| cpl.environment.application\_environment\_abc |  | ||||||
| ---------------------------------------------------- |  | ||||||
|  |  | ||||||
| .. automodule:: cpl.environment.application_environment_abc |  | ||||||
|    :members: |  | ||||||
|    :undoc-members: |  | ||||||
|    :show-inheritance: |  | ||||||
|  |  | ||||||
| cpl.environment.environment\_name\_enum |  | ||||||
| ---------------------------------------------- |  | ||||||
|  |  | ||||||
| .. automodule:: cpl.environment.environment_name_enum |  | ||||||
|    :members: |  | ||||||
|    :undoc-members: |  | ||||||
|    :show-inheritance: |  | ||||||
							
								
								
									
										16
									
								
								docs/build/html/_sources/cpl.rst.txt
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										16
									
								
								docs/build/html/_sources/cpl.rst.txt
									
									
									
									
										vendored
									
									
								
							| @@ -1,16 +0,0 @@ | |||||||
| API Reference |  | ||||||
| =========== |  | ||||||
|  |  | ||||||
| .. toctree:: |  | ||||||
|     :maxdepth: 4 |  | ||||||
|  |  | ||||||
|     cpl.application |  | ||||||
|     cpl.configuration |  | ||||||
|     cpl.console |  | ||||||
|     cpl.database |  | ||||||
|     cpl.dependency_injection |  | ||||||
|     cpl.environment |  | ||||||
|     cpl.logging |  | ||||||
|     cpl.mailing |  | ||||||
|     cpl.time |  | ||||||
|     cpl.utils |  | ||||||
| @@ -1,34 +1,34 @@ | |||||||
| cpl.application | cpl_core.application | ||||||
| ======================= | ======================= | ||||||
| 
 | 
 | ||||||
| cpl.application.application\_abc | cpl_core.application.application\_abc | ||||||
| --------------------------------------- | --------------------------------------- | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.application.application_abc | .. automodule:: cpl_core.application.application_abc | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.application.application\_builder | cpl_core.application.application\_builder | ||||||
| ------------------------------------------- | ------------------------------------------- | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.application.application_builder | .. automodule:: cpl_core.application.application_builder | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.application.application\_builder\_abc | cpl_core.application.application\_builder\_abc | ||||||
| ------------------------------------------------ | ------------------------------------------------ | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.application.application_builder_abc | .. automodule:: cpl_core.application.application_builder_abc | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.application.startup\_abc | cpl_core.application.startup\_abc | ||||||
| ----------------------------------- | ----------------------------------- | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.application.startup_abc | .. automodule:: cpl_core.application.startup_abc | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
							
								
								
									
										42
									
								
								docs/build/html/_sources/cpl_core.configuration.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										42
									
								
								docs/build/html/_sources/cpl_core.configuration.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,42 @@ | |||||||
|  | cpl_core.configuration | ||||||
|  | ========================= | ||||||
|  |  | ||||||
|  | cpl_core.configuration.configuration | ||||||
|  | -------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_core.configuration.configuration | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
|  |  | ||||||
|  | cpl_core.configuration.configuration\_abc | ||||||
|  | ------------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_core.configuration.configuration_abc | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
|  |  | ||||||
|  | cpl_core.configuration.configuration\_model\_abc | ||||||
|  | -------------------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_core.configuration.configuration_model_abc | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
|  |  | ||||||
|  | cpl_core.configuration.configuration\_variable\_name\_enum | ||||||
|  | ------------------------------------------------------------ | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_core.configuration.configuration_variable_name_enum | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
|  |  | ||||||
|  | cpl_core.configuration.console\_argument | ||||||
|  | ------------------------------------------ | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_core.configuration.console_argument | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
| @@ -1,42 +1,42 @@ | |||||||
| cpl.console | cpl_core.console | ||||||
| =================== | =================== | ||||||
| 
 | 
 | ||||||
| cpl.console.background\_color\_enum | cpl_core.console.background\_color\_enum | ||||||
| ------------------------------------------ | ------------------------------------------ | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.console.background_color_enum | .. automodule:: cpl_core.console.background_color_enum | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.console.console | cpl_core.console.console | ||||||
| -------------------------- | -------------------------- | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.console.console | .. automodule:: cpl_core.console.console | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.console.console\_call | cpl_core.console.console\_call | ||||||
| -------------------------------- | -------------------------------- | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.console.console_call | .. automodule:: cpl_core.console.console_call | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.console.foreground\_color\_enum | cpl_core.console.foreground\_color\_enum | ||||||
| ------------------------------------------ | ------------------------------------------ | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.console.foreground_color_enum | .. automodule:: cpl_core.console.foreground_color_enum | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.console.spinner\_thread | cpl_core.console.spinner\_thread | ||||||
| ---------------------------------- | ---------------------------------- | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.console.spinner_thread | .. automodule:: cpl_core.console.spinner_thread | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
							
								
								
									
										18
									
								
								docs/build/html/_sources/cpl_core.database.connection.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										18
									
								
								docs/build/html/_sources/cpl_core.database.connection.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,18 @@ | |||||||
|  | cpl_core.database.connection | ||||||
|  | =============================== | ||||||
|  |  | ||||||
|  | cpl_core.database.connection.database\_connection | ||||||
|  | --------------------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_core.database.connection.database_connection | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
|  |  | ||||||
|  | cpl_core.database.connection.database\_connection\_abc | ||||||
|  | -------------------------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_core.database.connection.database_connection_abc | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
							
								
								
									
										18
									
								
								docs/build/html/_sources/cpl_core.database.context.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										18
									
								
								docs/build/html/_sources/cpl_core.database.context.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,18 @@ | |||||||
|  | cpl_core.database.context | ||||||
|  | ============================ | ||||||
|  |  | ||||||
|  | cpl_core.database.context.database\_context | ||||||
|  | --------------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_core.database.context.database_context | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
|  |  | ||||||
|  | cpl_core.database.context.database\_context\_abc | ||||||
|  | -------------------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_core.database.context.database_context_abc | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
| @@ -1,35 +1,35 @@ | |||||||
| cpl.database | cpl_core.database | ||||||
| ==================== | ==================== | ||||||
| 
 | 
 | ||||||
| .. toctree:: | .. toctree:: | ||||||
|    :maxdepth: 4 |    :maxdepth: 4 | ||||||
| 
 | 
 | ||||||
|    cpl.database.connection |    cpl_core.database.connection | ||||||
|    cpl.database.context |    cpl_core.database.context | ||||||
| 
 | 
 | ||||||
| Submodules | Submodules | ||||||
| ---------- | ---------- | ||||||
| 
 | 
 | ||||||
| cpl.database.database\_model | cpl_core.database.database\_model | ||||||
| ----------------------------------- | ----------------------------------- | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.database.database_model | .. automodule:: cpl_core.database.database_model | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.database.database\_settings | cpl_core.database.database\_settings | ||||||
| -------------------------------------- | -------------------------------------- | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.database.database_settings | .. automodule:: cpl_core.database.database_settings | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.database.database\_settings\_name\_enum | cpl_core.database.database\_settings\_name\_enum | ||||||
| -------------------------------------------------- | -------------------------------------------------- | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.database.database_settings_name_enum | .. automodule:: cpl_core.database.database_settings_name_enum | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
							
								
								
									
										50
									
								
								docs/build/html/_sources/cpl_core.dependency_injection.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										50
									
								
								docs/build/html/_sources/cpl_core.dependency_injection.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,50 @@ | |||||||
|  | cpl_core.dependency\_injection | ||||||
|  | ================================= | ||||||
|  |  | ||||||
|  | cpl_core.dependency\_injection.service\_collection | ||||||
|  | ---------------------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_core.dependency_injection.service_collection | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
|  |  | ||||||
|  | cpl_core.dependency\_injection.service\_collection\_abc | ||||||
|  | --------------------------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_core.dependency_injection.service_collection_abc | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
|  |  | ||||||
|  | cpl_core.dependency\_injection.service\_descriptor | ||||||
|  | ---------------------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_core.dependency_injection.service_descriptor | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
|  |  | ||||||
|  | cpl_core.dependency\_injection.service\_lifetime\_enum | ||||||
|  | -------------------------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_core.dependency_injection.service_lifetime_enum | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
|  |  | ||||||
|  | cpl_core.dependency\_injection.service\_provider | ||||||
|  | -------------------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_core.dependency_injection.service_provider | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
|  |  | ||||||
|  | cpl_core.dependency\_injection.service\_provider\_abc | ||||||
|  | ------------------------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_core.dependency_injection.service_provider_abc | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
							
								
								
									
										26
									
								
								docs/build/html/_sources/cpl_core.environment.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										26
									
								
								docs/build/html/_sources/cpl_core.environment.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,26 @@ | |||||||
|  | cpl_core.environment | ||||||
|  | ======================= | ||||||
|  |  | ||||||
|  | cpl_core.environment.application\_environment | ||||||
|  | ----------------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_core.environment.application_environment | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
|  |  | ||||||
|  | cpl_core.environment.application\_environment\_abc | ||||||
|  | ---------------------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_core.environment.application_environment_abc | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
|  |  | ||||||
|  | cpl_core.environment.environment\_name\_enum | ||||||
|  | ---------------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_core.environment.environment_name_enum | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
| @@ -1,42 +1,42 @@ | |||||||
| cpl.logging | cpl_core.logging | ||||||
| =================== | =================== | ||||||
| 
 | 
 | ||||||
| cpl.logging.logger\_abc | cpl_core.logging.logger\_abc | ||||||
| ------------------------------ | ------------------------------ | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.logging.logger_abc | .. automodule:: cpl_core.logging.logger_abc | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.logging.logger\_service | cpl_core.logging.logger\_service | ||||||
| ---------------------------------- | ---------------------------------- | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.logging.logger_service | .. automodule:: cpl_core.logging.logger_service | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.logging.logging\_level\_enum | cpl_core.logging.logging\_level\_enum | ||||||
| --------------------------------------- | --------------------------------------- | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.logging.logging_level_enum | .. automodule:: cpl_core.logging.logging_level_enum | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.logging.logging\_settings | cpl_core.logging.logging\_settings | ||||||
| ------------------------------------ | ------------------------------------ | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.logging.logging_settings | .. automodule:: cpl_core.logging.logging_settings | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.logging.logging\_settings\_name\_enum | cpl_core.logging.logging\_settings\_name\_enum | ||||||
| ------------------------------------------------ | ------------------------------------------------ | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.logging.logging_settings_name_enum | .. automodule:: cpl_core.logging.logging_settings_name_enum | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| @@ -1,42 +1,42 @@ | |||||||
| cpl.mailing | cpl_core.mailing | ||||||
| =================== | =================== | ||||||
| 
 | 
 | ||||||
| cpl.mailing.email | cpl_core.mailing.email | ||||||
| ------------------------ | ------------------------ | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.mailing.email | .. automodule:: cpl_core.mailing.email | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.mailing.email\_client\_abc | cpl_core.mailing.email\_client\_abc | ||||||
| ------------------------------------- | ------------------------------------- | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.mailing.email_client_abc | .. automodule:: cpl_core.mailing.email_client_abc | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.mailing.email\_client\_service | cpl_core.mailing.email\_client\_service | ||||||
| ----------------------------------------- | ----------------------------------------- | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.mailing.email_client_service | .. automodule:: cpl_core.mailing.email_client_service | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.mailing.email\_client\_settings | cpl_core.mailing.email\_client\_settings | ||||||
| ------------------------------------------ | ------------------------------------------ | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.mailing.email_client_settings | .. automodule:: cpl_core.mailing.email_client_settings | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.mailing.email\_client\_settings\_name\_enum | cpl_core.mailing.email\_client\_settings\_name\_enum | ||||||
| ------------------------------------------------------ | ------------------------------------------------------ | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.mailing.email_client_settings_name_enum | .. automodule:: cpl_core.mailing.email_client_settings_name_enum | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
							
								
								
									
										16
									
								
								docs/build/html/_sources/cpl_core.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										16
									
								
								docs/build/html/_sources/cpl_core.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,16 @@ | |||||||
|  | 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.logging | ||||||
|  |     cpl_core.mailing | ||||||
|  |     cpl_core.time | ||||||
|  |     cpl_core.utils | ||||||
| @@ -1,18 +1,18 @@ | |||||||
| cpl.time | cpl_core.time | ||||||
| ================ | ================ | ||||||
| 
 | 
 | ||||||
| cpl.time.time\_format\_settings | cpl_core.time.time\_format\_settings | ||||||
| -------------------------------------- | -------------------------------------- | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.time.time_format_settings | .. automodule:: cpl_core.time.time_format_settings | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.time.time\_format\_settings\_names\_enum | cpl_core.time.time\_format\_settings\_names\_enum | ||||||
| --------------------------------------------------- | --------------------------------------------------- | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.time.time_format_settings_names_enum | .. automodule:: cpl_core.time.time_format_settings_names_enum | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| @@ -1,26 +1,26 @@ | |||||||
| cpl.utils | cpl_core.utils | ||||||
| ================= | ================= | ||||||
| 
 | 
 | ||||||
| cpl.utils.credential\_manager | cpl_core.utils.credential\_manager | ||||||
| ------------------------------------ | ------------------------------------ | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.utils.credential_manager | .. automodule:: cpl_core.utils.credential_manager | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.utils.pip | cpl_core.utils.pip | ||||||
| -------------------- | -------------------- | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.utils.pip | .. automodule:: cpl_core.utils.pip | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
| 
 | 
 | ||||||
| cpl.utils.string | cpl_core.utils.string | ||||||
| ----------------------- | ----------------------- | ||||||
| 
 | 
 | ||||||
| .. automodule:: cpl.utils.string | .. automodule:: cpl_core.utils.string | ||||||
|    :members: |    :members: | ||||||
|    :undoc-members: |    :undoc-members: | ||||||
|    :show-inheritance: |    :show-inheritance: | ||||||
							
								
								
									
										10
									
								
								docs/build/html/_sources/cpl_query.exceptions.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										10
									
								
								docs/build/html/_sources/cpl_query.exceptions.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,10 @@ | |||||||
|  | cpl_query.exceptions | ||||||
|  | ================================= | ||||||
|  |  | ||||||
|  | cpl_query.exceptions | ||||||
|  | ---------------------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_query.exceptions | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
							
								
								
									
										42
									
								
								docs/build/html/_sources/cpl_query.extension.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										42
									
								
								docs/build/html/_sources/cpl_query.extension.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,42 @@ | |||||||
|  | cpl_query.extension | ||||||
|  | ================================= | ||||||
|  |  | ||||||
|  | cpl_query.extension.iterable_abc | ||||||
|  | ---------------------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: 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 | ||||||
|  | ---------------------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_query.extension.list | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
|  |  | ||||||
|  | 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: | ||||||
							
								
								
									
										8
									
								
								docs/build/html/_sources/cpl_query.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										8
									
								
								docs/build/html/_sources/cpl_query.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,8 @@ | |||||||
|  | Query Reference | ||||||
|  | =========== | ||||||
|  |  | ||||||
|  | .. toctree:: | ||||||
|  |     :maxdepth: 4 | ||||||
|  |     | ||||||
|  |     cpl_query.extension | ||||||
|  |     cpl_query.exceptions | ||||||
							
								
								
									
										45
									
								
								docs/build/html/_sources/cpl_query.tests.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										45
									
								
								docs/build/html/_sources/cpl_query.tests.rst.txt
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,45 @@ | |||||||
|  | cpl\_query.tests package | ||||||
|  | ======================== | ||||||
|  |  | ||||||
|  | Submodules | ||||||
|  | ---------- | ||||||
|  |  | ||||||
|  | cpl\_query.tests.iterable\_test module | ||||||
|  | -------------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_query.tests.iterable_test | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
|  |  | ||||||
|  | cpl\_query.tests.models module | ||||||
|  | ------------------------------ | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_query.tests.models | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
|  |  | ||||||
|  | cpl\_query.tests.query\_test module | ||||||
|  | ----------------------------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_query.tests.query_test | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
|  |  | ||||||
|  | cpl\_query.tests.tester module | ||||||
|  | ------------------------------ | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_query.tests.tester | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
|  |  | ||||||
|  | Module contents | ||||||
|  | --------------- | ||||||
|  |  | ||||||
|  | .. automodule:: cpl_query.tests | ||||||
|  |    :members: | ||||||
|  |    :undoc-members: | ||||||
|  |    :show-inheritance: | ||||||
							
								
								
									
										3
									
								
								docs/build/html/_sources/index.rst.txt
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								docs/build/html/_sources/index.rst.txt
									
									
									
									
										vendored
									
									
								
							| @@ -20,5 +20,6 @@ These pages go into great detail about everything the Library can do. | |||||||
|  |  | ||||||
|    introduction |    introduction | ||||||
|    getting_started |    getting_started | ||||||
|    cpl |  | ||||||
|    cpl_cli |    cpl_cli | ||||||
|  |    cpl_core | ||||||
|  |    cpl_query | ||||||
|   | |||||||
							
								
								
									
										3
									
								
								docs/build/html/_sources/introduction.md.txt
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								docs/build/html/_sources/introduction.md.txt
									
									
									
									
										vendored
									
									
								
							| @@ -8,5 +8,6 @@ This CPL docs help you learn, understand and use the package. From your first ap | |||||||
|  |  | ||||||
| - [Getting started](quickstart) | - [Getting started](quickstart) | ||||||
| - [Setup](setup) | - [Setup](setup) | ||||||
| - [API Reference](cpl) | - [API Reference](cpl_core) | ||||||
| - [CLI Reference](cli.overview) | - [CLI Reference](cli.overview) | ||||||
|  | - [Query Reference](cpl_query) | ||||||
|   | |||||||
							
								
								
									
										3
									
								
								docs/build/html/_sources/modules.rst.txt
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								docs/build/html/_sources/modules.rst.txt
									
									
									
									
										vendored
									
									
								
							| @@ -5,5 +5,6 @@ cpl | |||||||
|     :maxdepth: 4 |     :maxdepth: 4 | ||||||
|  |  | ||||||
|     getting_started |     getting_started | ||||||
|     cpl |  | ||||||
|     cpl_cli |     cpl_cli | ||||||
|  |     cpl_core | ||||||
|  |     cpl_query | ||||||
|   | |||||||
							
								
								
									
										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: | 3. Add ```Console.select``` as follows: | ||||||
|  |  | ||||||
|     ```py |     ```py | ||||||
|     from cpl.console import Console |     from cpl_core.console import Console | ||||||
|  |  | ||||||
|  |  | ||||||
|     def main(): |     def main(): | ||||||
| @@ -156,7 +156,7 @@ To create the sample project to the following: | |||||||
|     import random |     import random | ||||||
|     import string |     import string | ||||||
|  |  | ||||||
|     from cpl.console import Console |     from cpl_core.console import Console | ||||||
|  |  | ||||||
|  |  | ||||||
|     def generate_password(letters: str, length: int) -> str: |     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: | To continue exploring CPL and developing applications: | ||||||
|  |  | ||||||
| - [Application base](cpl.application) | - [Application base](cpl_core.application) | ||||||
| - [Dependency injection](cpl.dependency_injection) | - [Dependency injection](cpl_core.dependency_injection) | ||||||
| - [Console](cpl.console) | - [Console](cpl_core.console) | ||||||
|  |  | ||||||
| <!-- LINKS --> | <!-- LINKS --> | ||||||
| [pip-url]: https://pip.sh-edraft.de | [pip-url]: https://pip.sh-edraft.de | ||||||
|   | |||||||
							
								
								
									
										15
									
								
								docs/build/html/_sources/setup.md.txt
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										15
									
								
								docs/build/html/_sources/setup.md.txt
									
									
									
									
										vendored
									
									
								
							| @@ -5,6 +5,7 @@ | |||||||
| 1. [Prerequisites](#prerequisites) | 1. [Prerequisites](#prerequisites) | ||||||
| 2. [Install the package](#install-the-package) | 2. [Install the package](#install-the-package) | ||||||
| 3. [Install the CLI](#install-the-cli) | 3. [Install the CLI](#install-the-cli) | ||||||
|  | 3. [Install the query](#install-the-query) | ||||||
| 4. [Create a initial application](#create-initial-console-app) | 4. [Create a initial application](#create-initial-console-app) | ||||||
| 5. [Create a initial library](#create-initial-library) | 5. [Create a initial library](#create-initial-library) | ||||||
| 6. [Start the application](#start-the-app) | 6. [Start the application](#start-the-app) | ||||||
| @@ -26,7 +27,7 @@ Also you need to have the following installed. | |||||||
| To install the package, open a terminal window and run the following command: | To install the package, open a terminal window and run the following command: | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| pip install sh_cpl --extra-index-url https://pip.sh-edraft.de | pip install sh_cpl-core --extra-index-url https://pip.sh-edraft.de | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## Install the CLI | ## Install the CLI | ||||||
| @@ -39,9 +40,17 @@ To install the CLI, open a terminal window and run the following command: | |||||||
| pip install sh_cpl-cli --extra-index-url https://pip.sh-edraft.de | pip install sh_cpl-cli --extra-index-url https://pip.sh-edraft.de | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
|  | ## Install the query | ||||||
|  |  | ||||||
|  | To install the package, open a terminal window and run the following command: | ||||||
|  |  | ||||||
|  | ```sh | ||||||
|  | pip install sh_cpl-query --extra-index-url https://pip.sh-edraft.de | ||||||
|  | ``` | ||||||
|  |  | ||||||
| ## Create initial console app | ## Create initial console app | ||||||
|  |  | ||||||
| You develop apps and packages in the context of an CPL project which is defined in an cpl.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: | 1. Run the CLI command ```cpl new console``` and provide the name my-app, as shown here: | ||||||
|  |  | ||||||
| @@ -55,7 +64,7 @@ The CLI create a new workspace and a simple 'Hello World' app, ready to run. | |||||||
|  |  | ||||||
| ## Create initial library | ## Create initial library | ||||||
|  |  | ||||||
| You develop apps and packages in the context of an CPL project which is defined in an cpl.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. Run the CLI command ```cpl new library``` and provide the name my-lib, as shown here: | ||||||
|  |  | ||||||
|   | |||||||
							
								
								
									
										3
									
								
								docs/build/html/cli.add.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								docs/build/html/cli.add.html
									
									
									
									
										vendored
									
									
								
							| @@ -87,7 +87,6 @@ | |||||||
|               <ul class="current"> |               <ul class="current"> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.html">API Reference</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | ||||||
| <li class="toctree-l2 current"><a class="current reference internal" href="#">cpl add</a><ul> | <li class="toctree-l2 current"><a class="current reference internal" href="#">cpl add</a><ul> | ||||||
| @@ -109,6 +108,8 @@ | |||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | ||||||
| </ul> | </ul> | ||||||
| </li> | </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_query.html">Query Reference</a></li> | ||||||
| </ul> | </ul> | ||||||
|  |  | ||||||
|              |              | ||||||
|   | |||||||
							
								
								
									
										3
									
								
								docs/build/html/cli.build.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								docs/build/html/cli.build.html
									
									
									
									
										vendored
									
									
								
							| @@ -87,7 +87,6 @@ | |||||||
|               <ul class="current"> |               <ul class="current"> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.html">API Reference</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | ||||||
| @@ -108,6 +107,8 @@ | |||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | ||||||
| </ul> | </ul> | ||||||
| </li> | </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_query.html">Query Reference</a></li> | ||||||
| </ul> | </ul> | ||||||
|  |  | ||||||
|              |              | ||||||
|   | |||||||
							
								
								
									
										5
									
								
								docs/build/html/cli.generate.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										5
									
								
								docs/build/html/cli.generate.html
									
									
									
									
										vendored
									
									
								
							| @@ -87,7 +87,6 @@ | |||||||
|               <ul class="current"> |               <ul class="current"> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.html">API Reference</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | ||||||
| @@ -110,6 +109,8 @@ | |||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | ||||||
| </ul> | </ul> | ||||||
| </li> | </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_query.html">Query Reference</a></li> | ||||||
| </ul> | </ul> | ||||||
|  |  | ||||||
|              |              | ||||||
| @@ -245,7 +246,7 @@ cpl <strong>G</strong> <em><schematic></em> <em><name></em></p> | |||||||
| <td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre"><name></span></code></p></td> | <td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre"><name></span></code></p></td> | ||||||
| </tr> | </tr> | ||||||
| <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">settings</span></code></p></td> | <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">settings</span></code></p></td> | ||||||
| <td class="text-align:center"><p><a class="reference internal" href="cpl.configuration.html"><span class="doc std std-doc">Configmodel</span></a></p></td> | <td class="text-align: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-align:center"><p><code class="docutils literal notranslate"><span class="pre"><name></span></code></p></td> | <td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre"><name></span></code></p></td> | ||||||
| </tr> | </tr> | ||||||
| <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">thread</span></code></p></td> | <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">thread</span></code></p></td> | ||||||
|   | |||||||
							
								
								
									
										3
									
								
								docs/build/html/cli.help.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								docs/build/html/cli.help.html
									
									
									
									
										vendored
									
									
								
							| @@ -87,7 +87,6 @@ | |||||||
|               <ul class="current"> |               <ul class="current"> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.html">API Reference</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | ||||||
| @@ -108,6 +107,8 @@ | |||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | ||||||
| </ul> | </ul> | ||||||
| </li> | </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_query.html">Query Reference</a></li> | ||||||
| </ul> | </ul> | ||||||
|  |  | ||||||
|              |              | ||||||
|   | |||||||
							
								
								
									
										3
									
								
								docs/build/html/cli.install.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								docs/build/html/cli.install.html
									
									
									
									
										vendored
									
									
								
							| @@ -87,7 +87,6 @@ | |||||||
|               <ul class="current"> |               <ul class="current"> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.html">API Reference</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | ||||||
| @@ -109,6 +108,8 @@ | |||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | ||||||
| </ul> | </ul> | ||||||
| </li> | </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_query.html">Query Reference</a></li> | ||||||
| </ul> | </ul> | ||||||
|  |  | ||||||
|              |              | ||||||
|   | |||||||
							
								
								
									
										3
									
								
								docs/build/html/cli.new.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								docs/build/html/cli.new.html
									
									
									
									
										vendored
									
									
								
							| @@ -87,7 +87,6 @@ | |||||||
|               <ul class="current"> |               <ul class="current"> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.html">API Reference</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | ||||||
| @@ -109,6 +108,8 @@ | |||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | ||||||
| </ul> | </ul> | ||||||
| </li> | </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_query.html">Query Reference</a></li> | ||||||
| </ul> | </ul> | ||||||
|  |  | ||||||
|              |              | ||||||
|   | |||||||
							
								
								
									
										3
									
								
								docs/build/html/cli.overview.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								docs/build/html/cli.overview.html
									
									
									
									
										vendored
									
									
								
							| @@ -87,7 +87,6 @@ | |||||||
|               <ul class="current"> |               <ul class="current"> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.html">API Reference</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | ||||||
| <li class="toctree-l2 current"><a class="current reference internal" href="#">CLI Overview and Command Reference</a><ul> | <li class="toctree-l2 current"><a class="current reference internal" href="#">CLI Overview and Command Reference</a><ul> | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#table-of-contents">Table of Contents</a></li> | <li class="toctree-l3"><a class="reference internal" href="#table-of-contents">Table of Contents</a></li> | ||||||
| @@ -114,6 +113,8 @@ | |||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | ||||||
| </ul> | </ul> | ||||||
| </li> | </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_query.html">Query Reference</a></li> | ||||||
| </ul> | </ul> | ||||||
|  |  | ||||||
|              |              | ||||||
|   | |||||||
							
								
								
									
										5
									
								
								docs/build/html/cli.publish.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										5
									
								
								docs/build/html/cli.publish.html
									
									
									
									
										vendored
									
									
								
							| @@ -87,7 +87,6 @@ | |||||||
|               <ul class="current"> |               <ul class="current"> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.html">API Reference</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | ||||||
| @@ -108,6 +107,8 @@ | |||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | ||||||
| </ul> | </ul> | ||||||
| </li> | </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_query.html">Query Reference</a></li> | ||||||
| </ul> | </ul> | ||||||
|  |  | ||||||
|              |              | ||||||
| @@ -193,7 +194,7 @@ cpl <strong>P</strong></p> | |||||||
| <div class="section" id="description"> | <div class="section" id="description"> | ||||||
| <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2> | <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2> | ||||||
| <p>The command can be used to publish a project of type “console” or “library”.</p> | <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.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> | 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> | <p>Generated files of <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> are in the ‘publish/setup/’ directory.</p> | ||||||
| <!-- ## Arguments | <!-- ## Arguments | ||||||
|   | |||||||
							
								
								
									
										9
									
								
								docs/build/html/cli.remove.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										9
									
								
								docs/build/html/cli.remove.html
									
									
									
									
										vendored
									
									
								
							| @@ -87,7 +87,6 @@ | |||||||
|               <ul class="current"> |               <ul class="current"> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.html">API Reference</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | ||||||
| @@ -109,6 +108,8 @@ | |||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | ||||||
| </ul> | </ul> | ||||||
| </li> | </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_query.html">Query Reference</a></li> | ||||||
| </ul> | </ul> | ||||||
|  |  | ||||||
|              |              | ||||||
| @@ -193,10 +194,8 @@ cpl <strong>R</strong> <em><project></em></p> | |||||||
| </div> | </div> | ||||||
| <div class="section" id="description"> | <div class="section" id="description"> | ||||||
| <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2> | <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2> | ||||||
| <p>The command can be used to publish a project of type “console” or “library”.</p> | <p>Removes a project reference and the files from workspace.</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.json</span></code>. | <p>If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified.</p> | ||||||
| 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> |  | ||||||
| </div> | </div> | ||||||
| <div class="section" id="arguments"> | <div class="section" id="arguments"> | ||||||
| <h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">¶</a></h2> | <h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">¶</a></h2> | ||||||
|   | |||||||
							
								
								
									
										3
									
								
								docs/build/html/cli.start.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								docs/build/html/cli.start.html
									
									
									
									
										vendored
									
									
								
							| @@ -87,7 +87,6 @@ | |||||||
|               <ul class="current"> |               <ul class="current"> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.html">API Reference</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | ||||||
| @@ -104,6 +103,8 @@ | |||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | ||||||
| </ul> | </ul> | ||||||
| </li> | </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_query.html">Query Reference</a></li> | ||||||
| </ul> | </ul> | ||||||
|  |  | ||||||
|              |              | ||||||
|   | |||||||
							
								
								
									
										3
									
								
								docs/build/html/cli.uninstall.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								docs/build/html/cli.uninstall.html
									
									
									
									
										vendored
									
									
								
							| @@ -87,7 +87,6 @@ | |||||||
|               <ul class="current"> |               <ul class="current"> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.html">API Reference</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | ||||||
| @@ -109,6 +108,8 @@ | |||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | ||||||
| </ul> | </ul> | ||||||
| </li> | </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_query.html">Query Reference</a></li> | ||||||
| </ul> | </ul> | ||||||
|  |  | ||||||
|              |              | ||||||
|   | |||||||
							
								
								
									
										3
									
								
								docs/build/html/cli.update.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								docs/build/html/cli.update.html
									
									
									
									
										vendored
									
									
								
							| @@ -87,7 +87,6 @@ | |||||||
|               <ul class="current"> |               <ul class="current"> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.html">API Reference</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | ||||||
| @@ -104,6 +103,8 @@ | |||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | ||||||
| </ul> | </ul> | ||||||
| </li> | </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_query.html">Query Reference</a></li> | ||||||
| </ul> | </ul> | ||||||
|  |  | ||||||
|              |              | ||||||
|   | |||||||
							
								
								
									
										5
									
								
								docs/build/html/cli.version.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										5
									
								
								docs/build/html/cli.version.html
									
									
									
									
										vendored
									
									
								
							| @@ -38,6 +38,7 @@ | |||||||
|      |      | ||||||
|     <link rel="index" title="Index" href="genindex.html" /> |     <link rel="index" title="Index" href="genindex.html" /> | ||||||
|     <link rel="search" title="Search" href="search.html" /> |     <link rel="search" title="Search" href="search.html" /> | ||||||
|  |     <link rel="next" title="API Reference" href="cpl_core.html" /> | ||||||
|     <link rel="prev" title="cpl update" href="cli.update.html" />  |     <link rel="prev" title="cpl update" href="cli.update.html" />  | ||||||
| </head> | </head> | ||||||
|  |  | ||||||
| @@ -86,7 +87,6 @@ | |||||||
|               <ul class="current"> |               <ul class="current"> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.html">API Reference</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | <li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current"> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | ||||||
| @@ -103,6 +103,8 @@ | |||||||
| <li class="toctree-l2 current"><a class="current reference internal" href="#">cpl version</a></li> | <li class="toctree-l2 current"><a class="current reference internal" href="#">cpl version</a></li> | ||||||
| </ul> | </ul> | ||||||
| </li> | </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_query.html">Query Reference</a></li> | ||||||
| </ul> | </ul> | ||||||
|  |  | ||||||
|              |              | ||||||
| @@ -186,6 +188,7 @@ cpl <strong>V</strong></p> | |||||||
|           </div> |           </div> | ||||||
|           <footer> |           <footer> | ||||||
|     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||||||
|  |         <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="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="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> | ||||||
|     </div> |     </div> | ||||||
|  |  | ||||||
|   | |||||||
							
								
								
									
										3
									
								
								docs/build/html/contributing.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								docs/build/html/contributing.html
									
									
									
									
										vendored
									
									
								
							| @@ -85,8 +85,9 @@ | |||||||
|               <ul> |               <ul> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.html">API Reference</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_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_query.html">Query Reference</a></li> | ||||||
| </ul> | </ul> | ||||||
|  |  | ||||||
|              |              | ||||||
|   | |||||||
							
								
								
									
										366
									
								
								docs/build/html/cpl.application.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										366
									
								
								docs/build/html/cpl.application.html
									
									
									
									
										vendored
									
									
								
							| @@ -1,366 +0,0 @@ | |||||||
|  |  | ||||||
|  |  | ||||||
| <!DOCTYPE html> |  | ||||||
| <html class="writer-html5" lang="en" > |  | ||||||
| <head> |  | ||||||
|   <meta charset="utf-8" /> |  | ||||||
|    |  | ||||||
|   <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |  | ||||||
|    |  | ||||||
|   <title>cpl.application — Common Python Library  documentation</title> |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |  | ||||||
|   <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <!--[if lt IE 9]> |  | ||||||
|     <script src="_static/js/html5shiv.min.js"></script> |  | ||||||
|   <![endif]--> |  | ||||||
|    |  | ||||||
|      |  | ||||||
|       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> |  | ||||||
|         <script src="_static/jquery.js"></script> |  | ||||||
|         <script src="_static/underscore.js"></script> |  | ||||||
|         <script src="_static/doctools.js"></script> |  | ||||||
|      |  | ||||||
|     <script type="text/javascript" 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.configuration" href="cpl.configuration.html" /> |  | ||||||
|     <link rel="prev" title="API Reference" href="cpl.html" />  |  | ||||||
| </head> |  | ||||||
|  |  | ||||||
| <body class="wy-body-for-nav"> |  | ||||||
|  |  | ||||||
|     |  | ||||||
|   <div class="wy-grid-for-nav"> |  | ||||||
|      |  | ||||||
|     <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |  | ||||||
|       <div class="wy-side-scroll"> |  | ||||||
|         <div class="wy-side-nav-search" > |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
|             <a href="index.html" class="icon icon-home"> Common Python Library |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
|           </a> |  | ||||||
|  |  | ||||||
|            |  | ||||||
|              |  | ||||||
|              |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
| <div role="search"> |  | ||||||
|   <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |  | ||||||
|     <input type="text" name="q" placeholder="Search docs" /> |  | ||||||
|     <input type="hidden" name="check_keywords" value="yes" /> |  | ||||||
|     <input type="hidden" name="area" value="default" /> |  | ||||||
|   </form> |  | ||||||
| </div> |  | ||||||
|  |  | ||||||
|            |  | ||||||
|         </div> |  | ||||||
|  |  | ||||||
|          |  | ||||||
|         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |  | ||||||
|            |  | ||||||
|              |  | ||||||
|              |  | ||||||
|                |  | ||||||
|              |  | ||||||
|              |  | ||||||
|               <ul class="current"> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current"> |  | ||||||
| <li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.application</a><ul> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.application.application_abc">cpl.application.application_abc</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.application.application_builder">cpl.application.application_builder</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.application.application_builder_abc">cpl.application.application_builder_abc</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.application.startup_abc">cpl.application.startup_abc</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.database.html">cpl.database</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.environment.html">cpl.environment</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.logging.html">cpl.logging</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li> |  | ||||||
| </ul> |  | ||||||
|  |  | ||||||
|              |  | ||||||
|            |  | ||||||
|         </div> |  | ||||||
|          |  | ||||||
|       </div> |  | ||||||
|     </nav> |  | ||||||
|  |  | ||||||
|     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |  | ||||||
|  |  | ||||||
|        |  | ||||||
|       <nav class="wy-nav-top" aria-label="top navigation"> |  | ||||||
|          |  | ||||||
|           <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |  | ||||||
|           <a href="index.html">Common Python Library</a> |  | ||||||
|          |  | ||||||
|       </nav> |  | ||||||
|  |  | ||||||
|  |  | ||||||
|       <div class="wy-nav-content"> |  | ||||||
|          |  | ||||||
|         <div class="rst-content"> |  | ||||||
|          |  | ||||||
|            |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
| <div role="navigation" aria-label="breadcrumbs navigation"> |  | ||||||
|  |  | ||||||
|   <ul class="wy-breadcrumbs"> |  | ||||||
|      |  | ||||||
|       <li><a href="index.html" class="icon icon-home"></a> »</li> |  | ||||||
|          |  | ||||||
|           <li><a href="cpl.html">API Reference</a> »</li> |  | ||||||
|          |  | ||||||
|       <li>cpl.application</li> |  | ||||||
|      |  | ||||||
|      |  | ||||||
|       <li class="wy-breadcrumbs-aside"> |  | ||||||
|          |  | ||||||
|            |  | ||||||
|             <a href="_sources/cpl.application.rst.txt" rel="nofollow"> View page source</a> |  | ||||||
|            |  | ||||||
|          |  | ||||||
|       </li> |  | ||||||
|      |  | ||||||
|   </ul> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <hr/> |  | ||||||
| </div> |  | ||||||
|           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |  | ||||||
|            <div itemprop="articleBody"> |  | ||||||
|              |  | ||||||
|   <div class="section" id="cpl-application"> |  | ||||||
| <h1>cpl.application<a class="headerlink" href="#cpl-application" title="Permalink to this headline">¶</a></h1> |  | ||||||
| <div class="section" id="module-cpl.application.application_abc"> |  | ||||||
| <span id="cpl-application-application-abc"></span><h2>cpl.application.application_abc<a class="headerlink" href="#module-cpl.application.application_abc" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.application.application_abc.ApplicationABC"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.application.application_abc.</span></code><code class="sig-name descname"><span class="pre">ApplicationABC</span></code><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="n"><a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.configuration.configuration_abc.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="n"><a class="reference internal" href="cpl.dependency_injection.html#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.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.ABC</span></code></p> |  | ||||||
| <p>ABC for the Application class</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>config: <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.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.dependency_injection.html#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></dt><dd><p>Contains instances of prepared objects</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.application.application_abc.ApplicationABC.configure"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">configure</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.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.application.application_abc.ApplicationABC.run" title="cpl.application.application_abc.ApplicationABC.run"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.application_abc.ApplicationABC.run</span></code></a></p> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.application.application_abc.ApplicationABC.main"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">main</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.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.application.application_abc.ApplicationABC.run" title="cpl.application.application_abc.ApplicationABC.run"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.application_abc.ApplicationABC.run</span></code></a></p> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.application.application_abc.ApplicationABC.run"> |  | ||||||
| <code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.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> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| <div class="section" id="module-cpl.application.application_builder"> |  | ||||||
| <span id="cpl-application-application-builder"></span><h2>cpl.application.application_builder<a class="headerlink" href="#module-cpl.application.application_builder" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.application.application_builder.ApplicationBuilder"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.application.application_builder.</span></code><code class="sig-name descname"><span class="pre">ApplicationBuilder</span></code><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="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.application.application_abc.ApplicationABC" title="cpl.application.application_abc.ApplicationABC"><span class="pre">cpl.application.application_abc.ApplicationABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.application.application_builder.ApplicationBuilder" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Bases: <a class="reference internal" href="#cpl.application.application_builder_abc.ApplicationBuilderABC" title="cpl.application.application_builder_abc.ApplicationBuilderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.application_builder_abc.ApplicationBuilderABC</span></code></a></p> |  | ||||||
| <p>This is class is used to build a object of <a class="reference internal" href="#cpl.application.application_abc.ApplicationABC" title="cpl.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.application_abc.ApplicationABC</span></code></a></p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>app: Type[<a class="reference internal" href="#cpl.application.application_abc.ApplicationABC" title="cpl.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.application_abc.ApplicationABC</span></code></a>]</dt><dd><p>Application to build</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.application.application_builder.ApplicationBuilder.build"> |  | ||||||
| <code class="sig-name descname"><span class="pre">build</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl.application.application_abc.ApplicationABC" title="cpl.application.application_abc.ApplicationABC"><span class="pre">cpl.application.application_abc.ApplicationABC</span></a><a class="headerlink" href="#cpl.application.application_builder.ApplicationBuilder.build" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Creates custom application object</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><p>Object of <a class="reference internal" href="#cpl.application.application_abc.ApplicationABC" title="cpl.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.application_abc.ApplicationABC</span></code></a></p> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.application.application_builder.ApplicationBuilder.use_startup"> |  | ||||||
| <code class="sig-name descname"><span class="pre">use_startup</span></code><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="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.application.startup_abc.StartupABC" title="cpl.application.startup_abc.StartupABC"><span class="pre">cpl.application.startup_abc.StartupABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.application.application_builder.ApplicationBuilder.use_startup" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Sets the custom startup class to use</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>startup: Type[<a class="reference internal" href="#cpl.application.startup_abc.StartupABC" title="cpl.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.startup_abc.StartupABC</span></code></a>]</dt><dd><p>Startup class to use</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| <div class="section" id="module-cpl.application.application_builder_abc"> |  | ||||||
| <span id="cpl-application-application-builder-abc"></span><h2>cpl.application.application_builder_abc<a class="headerlink" href="#module-cpl.application.application_builder_abc" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.application.application_builder_abc.ApplicationBuilderABC"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.application.application_builder_abc.</span></code><code class="sig-name descname"><span class="pre">ApplicationBuilderABC</span></code><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.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.ABC</span></code></p> |  | ||||||
| <p>ABC for the <a class="reference internal" href="#cpl.application.application_builder.ApplicationBuilder" title="cpl.application.application_builder.ApplicationBuilder"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.application_builder.ApplicationBuilder</span></code></a></p> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.application.application_builder_abc.ApplicationBuilderABC.build"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">build</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl.application.application_abc.ApplicationABC" title="cpl.application.application_abc.ApplicationABC"><span class="pre">cpl.application.application_abc.ApplicationABC</span></a><a class="headerlink" href="#cpl.application.application_builder_abc.ApplicationBuilderABC.build" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Creates custom application object</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><p>Object of <a class="reference internal" href="#cpl.application.application_abc.ApplicationABC" title="cpl.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.application_abc.ApplicationABC</span></code></a></p> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.application.application_builder_abc.ApplicationBuilderABC.use_startup"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">use_startup</span></code><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="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.application.startup_abc.StartupABC" title="cpl.application.startup_abc.StartupABC"><span class="pre">cpl.application.startup_abc.StartupABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.application.application_builder_abc.ApplicationBuilderABC.use_startup" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Sets the custom startup class to use</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>startup: Type[<a class="reference internal" href="#cpl.application.startup_abc.StartupABC" title="cpl.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.startup_abc.StartupABC</span></code></a>]</dt><dd><p>Startup class to use</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| <div class="section" id="module-cpl.application.startup_abc"> |  | ||||||
| <span id="cpl-application-startup-abc"></span><h2>cpl.application.startup_abc<a class="headerlink" href="#module-cpl.application.startup_abc" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.application.startup_abc.StartupABC"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.application.startup_abc.</span></code><code class="sig-name descname"><span class="pre">StartupABC</span></code><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.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.ABC</span></code></p> |  | ||||||
| <p>ABC for the startup class</p> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.application.startup_abc.StartupABC.configure_configuration"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">configure_configuration</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></a><a class="headerlink" href="#cpl.application.startup_abc.StartupABC.configure_configuration" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Creates configuration of application</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><p>Object of <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></code></a></p> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.application.startup_abc.StartupABC.configure_services"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">configure_services</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="cpl.dependency_injection.html#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></a><a class="headerlink" href="#cpl.application.startup_abc.StartupABC.configure_services" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Creates service provider</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><p>Object of <a class="reference internal" href="cpl.dependency_injection.html#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| </div> |  | ||||||
|  |  | ||||||
|  |  | ||||||
|            </div> |  | ||||||
|             |  | ||||||
|           </div> |  | ||||||
|           <footer> |  | ||||||
|     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |  | ||||||
|         <a href="cpl.configuration.html" class="btn btn-neutral float-right" title="cpl.configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |  | ||||||
|         <a href="cpl.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> |  | ||||||
|     </div> |  | ||||||
|  |  | ||||||
|   <hr/> |  | ||||||
|  |  | ||||||
|   <div role="contentinfo"> |  | ||||||
|     <p> |  | ||||||
|         © Copyright 2021, Sven Heidemann. |  | ||||||
|  |  | ||||||
|     </p> |  | ||||||
|   </div> |  | ||||||
|      |  | ||||||
|      |  | ||||||
|      |  | ||||||
|     Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |  | ||||||
|      |  | ||||||
|     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |  | ||||||
|      |  | ||||||
|     provided by <a href="https://readthedocs.org">Read the Docs</a>.  |  | ||||||
|  |  | ||||||
| </footer> |  | ||||||
|         </div> |  | ||||||
|       </div> |  | ||||||
|  |  | ||||||
|     </section> |  | ||||||
|  |  | ||||||
|   </div> |  | ||||||
|    |  | ||||||
|  |  | ||||||
|   <script type="text/javascript"> |  | ||||||
|       jQuery(function () { |  | ||||||
|           SphinxRtdTheme.Navigation.enable(true); |  | ||||||
|       }); |  | ||||||
|   </script> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|      |  | ||||||
|     |  | ||||||
|  |  | ||||||
| </body> |  | ||||||
| </html> |  | ||||||
							
								
								
									
										306
									
								
								docs/build/html/cpl.database.connection.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										306
									
								
								docs/build/html/cpl.database.connection.html
									
									
									
									
										vendored
									
									
								
							| @@ -1,306 +0,0 @@ | |||||||
|  |  | ||||||
|  |  | ||||||
| <!DOCTYPE html> |  | ||||||
| <html class="writer-html5" lang="en" > |  | ||||||
| <head> |  | ||||||
|   <meta charset="utf-8" /> |  | ||||||
|    |  | ||||||
|   <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |  | ||||||
|    |  | ||||||
|   <title>cpl.database.connection — Common Python Library  documentation</title> |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |  | ||||||
|   <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <!--[if lt IE 9]> |  | ||||||
|     <script src="_static/js/html5shiv.min.js"></script> |  | ||||||
|   <![endif]--> |  | ||||||
|    |  | ||||||
|      |  | ||||||
|       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> |  | ||||||
|         <script src="_static/jquery.js"></script> |  | ||||||
|         <script src="_static/underscore.js"></script> |  | ||||||
|         <script src="_static/doctools.js"></script> |  | ||||||
|      |  | ||||||
|     <script type="text/javascript" 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.database.context" href="cpl.database.context.html" /> |  | ||||||
|     <link rel="prev" title="cpl.database" href="cpl.database.html" />  |  | ||||||
| </head> |  | ||||||
|  |  | ||||||
| <body class="wy-body-for-nav"> |  | ||||||
|  |  | ||||||
|     |  | ||||||
|   <div class="wy-grid-for-nav"> |  | ||||||
|      |  | ||||||
|     <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |  | ||||||
|       <div class="wy-side-scroll"> |  | ||||||
|         <div class="wy-side-nav-search" > |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
|             <a href="index.html" class="icon icon-home"> Common Python Library |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
|           </a> |  | ||||||
|  |  | ||||||
|            |  | ||||||
|              |  | ||||||
|              |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
| <div role="search"> |  | ||||||
|   <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |  | ||||||
|     <input type="text" name="q" placeholder="Search docs" /> |  | ||||||
|     <input type="hidden" name="check_keywords" value="yes" /> |  | ||||||
|     <input type="hidden" name="area" value="default" /> |  | ||||||
|   </form> |  | ||||||
| </div> |  | ||||||
|  |  | ||||||
|            |  | ||||||
|         </div> |  | ||||||
|  |  | ||||||
|          |  | ||||||
|         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |  | ||||||
|            |  | ||||||
|              |  | ||||||
|              |  | ||||||
|                |  | ||||||
|              |  | ||||||
|              |  | ||||||
|               <ul class="current"> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current"> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li> |  | ||||||
| <li class="toctree-l2 current"><a class="reference internal" href="cpl.database.html">cpl.database</a><ul class="current"> |  | ||||||
| <li class="toctree-l3 current"><a class="current reference internal" href="#">cpl.database.connection</a><ul> |  | ||||||
| <li class="toctree-l4"><a class="reference internal" href="#module-cpl.database.connection.database_connection">cpl.database.connection.database_connection</a></li> |  | ||||||
| <li class="toctree-l4"><a class="reference internal" href="#module-cpl.database.connection.database_connection_abc">cpl.database.connection.database_connection_abc</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="cpl.database.context.html">cpl.database.context</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="cpl.database.html#submodules">Submodules</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_model">cpl.database.database_model</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings">cpl.database.database_settings</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings_name_enum">cpl.database.database_settings_name_enum</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.environment.html">cpl.environment</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.logging.html">cpl.logging</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li> |  | ||||||
| </ul> |  | ||||||
|  |  | ||||||
|              |  | ||||||
|            |  | ||||||
|         </div> |  | ||||||
|          |  | ||||||
|       </div> |  | ||||||
|     </nav> |  | ||||||
|  |  | ||||||
|     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |  | ||||||
|  |  | ||||||
|        |  | ||||||
|       <nav class="wy-nav-top" aria-label="top navigation"> |  | ||||||
|          |  | ||||||
|           <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |  | ||||||
|           <a href="index.html">Common Python Library</a> |  | ||||||
|          |  | ||||||
|       </nav> |  | ||||||
|  |  | ||||||
|  |  | ||||||
|       <div class="wy-nav-content"> |  | ||||||
|          |  | ||||||
|         <div class="rst-content"> |  | ||||||
|          |  | ||||||
|            |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
| <div role="navigation" aria-label="breadcrumbs navigation"> |  | ||||||
|  |  | ||||||
|   <ul class="wy-breadcrumbs"> |  | ||||||
|      |  | ||||||
|       <li><a href="index.html" class="icon icon-home"></a> »</li> |  | ||||||
|          |  | ||||||
|           <li><a href="cpl.html">API Reference</a> »</li> |  | ||||||
|          |  | ||||||
|           <li><a href="cpl.database.html">cpl.database</a> »</li> |  | ||||||
|          |  | ||||||
|       <li>cpl.database.connection</li> |  | ||||||
|      |  | ||||||
|      |  | ||||||
|       <li class="wy-breadcrumbs-aside"> |  | ||||||
|          |  | ||||||
|            |  | ||||||
|             <a href="_sources/cpl.database.connection.rst.txt" rel="nofollow"> View page source</a> |  | ||||||
|            |  | ||||||
|          |  | ||||||
|       </li> |  | ||||||
|      |  | ||||||
|   </ul> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <hr/> |  | ||||||
| </div> |  | ||||||
|           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |  | ||||||
|            <div itemprop="articleBody"> |  | ||||||
|              |  | ||||||
|   <div class="section" id="cpl-database-connection"> |  | ||||||
| <h1>cpl.database.connection<a class="headerlink" href="#cpl-database-connection" title="Permalink to this headline">¶</a></h1> |  | ||||||
| <div class="section" id="module-cpl.database.connection.database_connection"> |  | ||||||
| <span id="cpl-database-connection-database-connection"></span><h2>cpl.database.connection.database_connection<a class="headerlink" href="#module-cpl.database.connection.database_connection" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.database.connection.database_connection.DatabaseConnection"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.database.connection.database_connection.</span></code><code class="sig-name descname"><span class="pre">DatabaseConnection</span></code><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="n"><a class="reference internal" href="cpl.database.html#cpl.database.database_settings.DatabaseSettings" title="cpl.database.database_settings.DatabaseSettings"><span class="pre">cpl.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.database.connection.database_connection.DatabaseConnection" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Bases: <a class="reference internal" href="#cpl.database.connection.database_connection_abc.DatabaseConnectionABC" title="cpl.database.connection.database_connection_abc.DatabaseConnectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.connection.database_connection_abc.DatabaseConnectionABC</span></code></a></p> |  | ||||||
| <p>Representation of the database connection</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><p>database_settings: <a class="reference internal" href="cpl.database.html#cpl.database.database_settings.DatabaseSettings" title="cpl.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.database_settings.DatabaseSettings</span></code></a></p> |  | ||||||
| </div></blockquote> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.database.connection.database_connection.DatabaseConnection.connect"> |  | ||||||
| <code class="sig-name descname"><span class="pre">connect</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection_string</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.database.connection.database_connection.DatabaseConnection.connect" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Connects to a database by connection string</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>connection_string: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Database connection string, see: <a class="reference external" href="https://docs.sqlalchemy.org/en/14/core/engines.html">https://docs.sqlalchemy.org/en/14/core/engines.html</a></p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.database.connection.database_connection.DatabaseConnection.engine"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">engine</span></code><a class="headerlink" href="#cpl.database.connection.database_connection.DatabaseConnection.engine" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.database.connection.database_connection.DatabaseConnection.session"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">session</span></code><a class="headerlink" href="#cpl.database.connection.database_connection.DatabaseConnection.session" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| <div class="section" id="module-cpl.database.connection.database_connection_abc"> |  | ||||||
| <span id="cpl-database-connection-database-connection-abc"></span><h2>cpl.database.connection.database_connection_abc<a class="headerlink" href="#module-cpl.database.connection.database_connection_abc" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.database.connection.database_connection_abc.DatabaseConnectionABC"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.database.connection.database_connection_abc.</span></code><code class="sig-name descname"><span class="pre">DatabaseConnectionABC</span></code><a class="headerlink" href="#cpl.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.ABC</span></code></p> |  | ||||||
| <p>ABC for the <a class="reference internal" href="#cpl.database.connection.database_connection.DatabaseConnection" title="cpl.database.connection.database_connection.DatabaseConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.connection.database_connection.DatabaseConnection</span></code></a></p> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.database.connection.database_connection_abc.DatabaseConnectionABC.connect"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">connect</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection_string</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.database.connection.database_connection_abc.DatabaseConnectionABC.connect" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Connects to a database by connection string</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>connection_string: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Database connection string, see: <a class="reference external" href="https://docs.sqlalchemy.org/en/14/core/engines.html">https://docs.sqlalchemy.org/en/14/core/engines.html</a></p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.database.connection.database_connection_abc.DatabaseConnectionABC.engine"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">engine</span></code><a class="headerlink" href="#cpl.database.connection.database_connection_abc.DatabaseConnectionABC.engine" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.database.connection.database_connection_abc.DatabaseConnectionABC.session"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">session</span></code><a class="headerlink" href="#cpl.database.connection.database_connection_abc.DatabaseConnectionABC.session" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| </div> |  | ||||||
|  |  | ||||||
|  |  | ||||||
|            </div> |  | ||||||
|             |  | ||||||
|           </div> |  | ||||||
|           <footer> |  | ||||||
|     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |  | ||||||
|         <a href="cpl.database.context.html" class="btn btn-neutral float-right" title="cpl.database.context" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |  | ||||||
|         <a href="cpl.database.html" class="btn btn-neutral float-left" title="cpl.database" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |  | ||||||
|     </div> |  | ||||||
|  |  | ||||||
|   <hr/> |  | ||||||
|  |  | ||||||
|   <div role="contentinfo"> |  | ||||||
|     <p> |  | ||||||
|         © Copyright 2021, Sven Heidemann. |  | ||||||
|  |  | ||||||
|     </p> |  | ||||||
|   </div> |  | ||||||
|      |  | ||||||
|      |  | ||||||
|      |  | ||||||
|     Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |  | ||||||
|      |  | ||||||
|     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |  | ||||||
|      |  | ||||||
|     provided by <a href="https://readthedocs.org">Read the Docs</a>.  |  | ||||||
|  |  | ||||||
| </footer> |  | ||||||
|         </div> |  | ||||||
|       </div> |  | ||||||
|  |  | ||||||
|     </section> |  | ||||||
|  |  | ||||||
|   </div> |  | ||||||
|    |  | ||||||
|  |  | ||||||
|   <script type="text/javascript"> |  | ||||||
|       jQuery(function () { |  | ||||||
|           SphinxRtdTheme.Navigation.enable(true); |  | ||||||
|       }); |  | ||||||
|   </script> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|      |  | ||||||
|     |  | ||||||
|  |  | ||||||
| </body> |  | ||||||
| </html> |  | ||||||
							
								
								
									
										318
									
								
								docs/build/html/cpl.database.context.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										318
									
								
								docs/build/html/cpl.database.context.html
									
									
									
									
										vendored
									
									
								
							| @@ -1,318 +0,0 @@ | |||||||
|  |  | ||||||
|  |  | ||||||
| <!DOCTYPE html> |  | ||||||
| <html class="writer-html5" lang="en" > |  | ||||||
| <head> |  | ||||||
|   <meta charset="utf-8" /> |  | ||||||
|    |  | ||||||
|   <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |  | ||||||
|    |  | ||||||
|   <title>cpl.database.context — Common Python Library  documentation</title> |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |  | ||||||
|   <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <!--[if lt IE 9]> |  | ||||||
|     <script src="_static/js/html5shiv.min.js"></script> |  | ||||||
|   <![endif]--> |  | ||||||
|    |  | ||||||
|      |  | ||||||
|       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> |  | ||||||
|         <script src="_static/jquery.js"></script> |  | ||||||
|         <script src="_static/underscore.js"></script> |  | ||||||
|         <script src="_static/doctools.js"></script> |  | ||||||
|      |  | ||||||
|     <script type="text/javascript" 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.dependency_injection" href="cpl.dependency_injection.html" /> |  | ||||||
|     <link rel="prev" title="cpl.database.connection" href="cpl.database.connection.html" />  |  | ||||||
| </head> |  | ||||||
|  |  | ||||||
| <body class="wy-body-for-nav"> |  | ||||||
|  |  | ||||||
|     |  | ||||||
|   <div class="wy-grid-for-nav"> |  | ||||||
|      |  | ||||||
|     <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |  | ||||||
|       <div class="wy-side-scroll"> |  | ||||||
|         <div class="wy-side-nav-search" > |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
|             <a href="index.html" class="icon icon-home"> Common Python Library |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
|           </a> |  | ||||||
|  |  | ||||||
|            |  | ||||||
|              |  | ||||||
|              |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
| <div role="search"> |  | ||||||
|   <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |  | ||||||
|     <input type="text" name="q" placeholder="Search docs" /> |  | ||||||
|     <input type="hidden" name="check_keywords" value="yes" /> |  | ||||||
|     <input type="hidden" name="area" value="default" /> |  | ||||||
|   </form> |  | ||||||
| </div> |  | ||||||
|  |  | ||||||
|            |  | ||||||
|         </div> |  | ||||||
|  |  | ||||||
|          |  | ||||||
|         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |  | ||||||
|            |  | ||||||
|              |  | ||||||
|              |  | ||||||
|                |  | ||||||
|              |  | ||||||
|              |  | ||||||
|               <ul class="current"> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current"> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li> |  | ||||||
| <li class="toctree-l2 current"><a class="reference internal" href="cpl.database.html">cpl.database</a><ul class="current"> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="cpl.database.connection.html">cpl.database.connection</a></li> |  | ||||||
| <li class="toctree-l3 current"><a class="current reference internal" href="#">cpl.database.context</a><ul> |  | ||||||
| <li class="toctree-l4"><a class="reference internal" href="#module-cpl.database.context.database_context">cpl.database.context.database_context</a></li> |  | ||||||
| <li class="toctree-l4"><a class="reference internal" href="#module-cpl.database.context.database_context_abc">cpl.database.context.database_context_abc</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="cpl.database.html#submodules">Submodules</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_model">cpl.database.database_model</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings">cpl.database.database_settings</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings_name_enum">cpl.database.database_settings_name_enum</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.environment.html">cpl.environment</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.logging.html">cpl.logging</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li> |  | ||||||
| </ul> |  | ||||||
|  |  | ||||||
|              |  | ||||||
|            |  | ||||||
|         </div> |  | ||||||
|          |  | ||||||
|       </div> |  | ||||||
|     </nav> |  | ||||||
|  |  | ||||||
|     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |  | ||||||
|  |  | ||||||
|        |  | ||||||
|       <nav class="wy-nav-top" aria-label="top navigation"> |  | ||||||
|          |  | ||||||
|           <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |  | ||||||
|           <a href="index.html">Common Python Library</a> |  | ||||||
|          |  | ||||||
|       </nav> |  | ||||||
|  |  | ||||||
|  |  | ||||||
|       <div class="wy-nav-content"> |  | ||||||
|          |  | ||||||
|         <div class="rst-content"> |  | ||||||
|          |  | ||||||
|            |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
| <div role="navigation" aria-label="breadcrumbs navigation"> |  | ||||||
|  |  | ||||||
|   <ul class="wy-breadcrumbs"> |  | ||||||
|      |  | ||||||
|       <li><a href="index.html" class="icon icon-home"></a> »</li> |  | ||||||
|          |  | ||||||
|           <li><a href="cpl.html">API Reference</a> »</li> |  | ||||||
|          |  | ||||||
|           <li><a href="cpl.database.html">cpl.database</a> »</li> |  | ||||||
|          |  | ||||||
|       <li>cpl.database.context</li> |  | ||||||
|      |  | ||||||
|      |  | ||||||
|       <li class="wy-breadcrumbs-aside"> |  | ||||||
|          |  | ||||||
|            |  | ||||||
|             <a href="_sources/cpl.database.context.rst.txt" rel="nofollow"> View page source</a> |  | ||||||
|            |  | ||||||
|          |  | ||||||
|       </li> |  | ||||||
|      |  | ||||||
|   </ul> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <hr/> |  | ||||||
| </div> |  | ||||||
|           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |  | ||||||
|            <div itemprop="articleBody"> |  | ||||||
|              |  | ||||||
|   <div class="section" id="cpl-database-context"> |  | ||||||
| <h1>cpl.database.context<a class="headerlink" href="#cpl-database-context" title="Permalink to this headline">¶</a></h1> |  | ||||||
| <div class="section" id="module-cpl.database.context.database_context"> |  | ||||||
| <span id="cpl-database-context-database-context"></span><h2>cpl.database.context.database_context<a class="headerlink" href="#module-cpl.database.context.database_context" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.database.context.database_context.DatabaseContext"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.database.context.database_context.</span></code><code class="sig-name descname"><span class="pre">DatabaseContext</span></code><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="n"><a class="reference internal" href="cpl.database.html#cpl.database.database_settings.DatabaseSettings" title="cpl.database.database_settings.DatabaseSettings"><span class="pre">cpl.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.database.context.database_context.DatabaseContext" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Bases: <a class="reference internal" href="#cpl.database.context.database_context_abc.DatabaseContextABC" title="cpl.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.context.database_context_abc.DatabaseContextABC</span></code></a></p> |  | ||||||
| <p>Representation of the database context</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><p>database_settings: <a class="reference internal" href="cpl.database.html#cpl.database.database_settings.DatabaseSettings" title="cpl.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.database_settings.DatabaseSettings</span></code></a></p> |  | ||||||
| </div></blockquote> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.database.context.database_context.DatabaseContext.connect"> |  | ||||||
| <code class="sig-name descname"><span class="pre">connect</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection_string</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.database.context.database_context.DatabaseContext.connect" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Connects to a database by connection string</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>connection_string: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Database connection string, see: <a class="reference external" href="https://docs.sqlalchemy.org/en/14/core/engines.html">https://docs.sqlalchemy.org/en/14/core/engines.html</a></p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.database.context.database_context.DatabaseContext.engine"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">engine</span></code><a class="headerlink" href="#cpl.database.context.database_context.DatabaseContext.engine" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.database.context.database_context.DatabaseContext.save_changes"> |  | ||||||
| <code class="sig-name descname"><span class="pre">save_changes</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.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 id="cpl.database.context.database_context.DatabaseContext.session"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">session</span></code><a class="headerlink" href="#cpl.database.context.database_context.DatabaseContext.session" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| <div class="section" id="module-cpl.database.context.database_context_abc"> |  | ||||||
| <span id="cpl-database-context-database-context-abc"></span><h2>cpl.database.context.database_context_abc<a class="headerlink" href="#module-cpl.database.context.database_context_abc" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.database.context.database_context_abc.DatabaseContextABC"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.database.context.database_context_abc.</span></code><code class="sig-name descname"><span class="pre">DatabaseContextABC</span></code><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.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.ABC</span></code></p> |  | ||||||
| <p>ABC for the <a class="reference internal" href="#cpl.database.context.database_context.DatabaseContext" title="cpl.database.context.database_context.DatabaseContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.context.database_context.DatabaseContext</span></code></a></p> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.database.context.database_context_abc.DatabaseContextABC.connect"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">connect</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection_string</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.database.context.database_context_abc.DatabaseContextABC.connect" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Connects to a database by connection string</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>connection_string: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Database connection string, see: <a class="reference external" href="https://docs.sqlalchemy.org/en/14/core/engines.html">https://docs.sqlalchemy.org/en/14/core/engines.html</a></p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.database.context.database_context_abc.DatabaseContextABC.engine"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">engine</span></code><a class="headerlink" href="#cpl.database.context.database_context_abc.DatabaseContextABC.engine" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.database.context.database_context_abc.DatabaseContextABC.save_changes"> |  | ||||||
| <code class="sig-name descname"><span class="pre">save_changes</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.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 id="cpl.database.context.database_context_abc.DatabaseContextABC.session"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">session</span></code><a class="headerlink" href="#cpl.database.context.database_context_abc.DatabaseContextABC.session" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| </div> |  | ||||||
|  |  | ||||||
|  |  | ||||||
|            </div> |  | ||||||
|             |  | ||||||
|           </div> |  | ||||||
|           <footer> |  | ||||||
|     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |  | ||||||
|         <a href="cpl.dependency_injection.html" class="btn btn-neutral float-right" title="cpl.dependency_injection" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |  | ||||||
|         <a href="cpl.database.connection.html" class="btn btn-neutral float-left" title="cpl.database.connection" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |  | ||||||
|     </div> |  | ||||||
|  |  | ||||||
|   <hr/> |  | ||||||
|  |  | ||||||
|   <div role="contentinfo"> |  | ||||||
|     <p> |  | ||||||
|         © Copyright 2021, Sven Heidemann. |  | ||||||
|  |  | ||||||
|     </p> |  | ||||||
|   </div> |  | ||||||
|      |  | ||||||
|      |  | ||||||
|      |  | ||||||
|     Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |  | ||||||
|      |  | ||||||
|     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |  | ||||||
|      |  | ||||||
|     provided by <a href="https://readthedocs.org">Read the Docs</a>.  |  | ||||||
|  |  | ||||||
| </footer> |  | ||||||
|         </div> |  | ||||||
|       </div> |  | ||||||
|  |  | ||||||
|     </section> |  | ||||||
|  |  | ||||||
|   </div> |  | ||||||
|    |  | ||||||
|  |  | ||||||
|   <script type="text/javascript"> |  | ||||||
|       jQuery(function () { |  | ||||||
|           SphinxRtdTheme.Navigation.enable(true); |  | ||||||
|       }); |  | ||||||
|   </script> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|      |  | ||||||
|     |  | ||||||
|  |  | ||||||
| </body> |  | ||||||
| </html> |  | ||||||
							
								
								
									
										340
									
								
								docs/build/html/cpl.database.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										340
									
								
								docs/build/html/cpl.database.html
									
									
									
									
										vendored
									
									
								
							| @@ -1,340 +0,0 @@ | |||||||
|  |  | ||||||
|  |  | ||||||
| <!DOCTYPE html> |  | ||||||
| <html class="writer-html5" lang="en" > |  | ||||||
| <head> |  | ||||||
|   <meta charset="utf-8" /> |  | ||||||
|    |  | ||||||
|   <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |  | ||||||
|    |  | ||||||
|   <title>cpl.database — Common Python Library  documentation</title> |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |  | ||||||
|   <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <!--[if lt IE 9]> |  | ||||||
|     <script src="_static/js/html5shiv.min.js"></script> |  | ||||||
|   <![endif]--> |  | ||||||
|    |  | ||||||
|      |  | ||||||
|       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> |  | ||||||
|         <script src="_static/jquery.js"></script> |  | ||||||
|         <script src="_static/underscore.js"></script> |  | ||||||
|         <script src="_static/doctools.js"></script> |  | ||||||
|      |  | ||||||
|     <script type="text/javascript" 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.database.connection" href="cpl.database.connection.html" /> |  | ||||||
|     <link rel="prev" title="cpl.console" href="cpl.console.html" />  |  | ||||||
| </head> |  | ||||||
|  |  | ||||||
| <body class="wy-body-for-nav"> |  | ||||||
|  |  | ||||||
|     |  | ||||||
|   <div class="wy-grid-for-nav"> |  | ||||||
|      |  | ||||||
|     <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |  | ||||||
|       <div class="wy-side-scroll"> |  | ||||||
|         <div class="wy-side-nav-search" > |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
|             <a href="index.html" class="icon icon-home"> Common Python Library |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
|           </a> |  | ||||||
|  |  | ||||||
|            |  | ||||||
|              |  | ||||||
|              |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
| <div role="search"> |  | ||||||
|   <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |  | ||||||
|     <input type="text" name="q" placeholder="Search docs" /> |  | ||||||
|     <input type="hidden" name="check_keywords" value="yes" /> |  | ||||||
|     <input type="hidden" name="area" value="default" /> |  | ||||||
|   </form> |  | ||||||
| </div> |  | ||||||
|  |  | ||||||
|            |  | ||||||
|         </div> |  | ||||||
|  |  | ||||||
|          |  | ||||||
|         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |  | ||||||
|            |  | ||||||
|              |  | ||||||
|              |  | ||||||
|                |  | ||||||
|              |  | ||||||
|              |  | ||||||
|               <ul class="current"> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current"> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li> |  | ||||||
| <li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.database</a><ul> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="cpl.database.connection.html">cpl.database.connection</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="cpl.database.context.html">cpl.database.context</a></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.database.database_model">cpl.database.database_model</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.database.database_settings">cpl.database.database_settings</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.database.database_settings_name_enum">cpl.database.database_settings_name_enum</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.environment.html">cpl.environment</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.logging.html">cpl.logging</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li> |  | ||||||
| </ul> |  | ||||||
|  |  | ||||||
|              |  | ||||||
|            |  | ||||||
|         </div> |  | ||||||
|          |  | ||||||
|       </div> |  | ||||||
|     </nav> |  | ||||||
|  |  | ||||||
|     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |  | ||||||
|  |  | ||||||
|        |  | ||||||
|       <nav class="wy-nav-top" aria-label="top navigation"> |  | ||||||
|          |  | ||||||
|           <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |  | ||||||
|           <a href="index.html">Common Python Library</a> |  | ||||||
|          |  | ||||||
|       </nav> |  | ||||||
|  |  | ||||||
|  |  | ||||||
|       <div class="wy-nav-content"> |  | ||||||
|          |  | ||||||
|         <div class="rst-content"> |  | ||||||
|          |  | ||||||
|            |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
| <div role="navigation" aria-label="breadcrumbs navigation"> |  | ||||||
|  |  | ||||||
|   <ul class="wy-breadcrumbs"> |  | ||||||
|      |  | ||||||
|       <li><a href="index.html" class="icon icon-home"></a> »</li> |  | ||||||
|          |  | ||||||
|           <li><a href="cpl.html">API Reference</a> »</li> |  | ||||||
|          |  | ||||||
|       <li>cpl.database</li> |  | ||||||
|      |  | ||||||
|      |  | ||||||
|       <li class="wy-breadcrumbs-aside"> |  | ||||||
|          |  | ||||||
|            |  | ||||||
|             <a href="_sources/cpl.database.rst.txt" rel="nofollow"> View page source</a> |  | ||||||
|            |  | ||||||
|          |  | ||||||
|       </li> |  | ||||||
|      |  | ||||||
|   </ul> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <hr/> |  | ||||||
| </div> |  | ||||||
|           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |  | ||||||
|            <div itemprop="articleBody"> |  | ||||||
|              |  | ||||||
|   <div class="section" id="cpl-database"> |  | ||||||
| <h1>cpl.database<a class="headerlink" href="#cpl-database" title="Permalink to this headline">¶</a></h1> |  | ||||||
| <div class="toctree-wrapper compound"> |  | ||||||
| <ul> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.database.connection.html">cpl.database.connection</a><ul> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.database.connection.html#module-cpl.database.connection.database_connection">cpl.database.connection.database_connection</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.database.connection.html#module-cpl.database.connection.database_connection_abc">cpl.database.connection.database_connection_abc</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.database.context.html">cpl.database.context</a><ul> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.database.context.html#module-cpl.database.context.database_context">cpl.database.context.database_context</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.database.context.html#module-cpl.database.context.database_context_abc">cpl.database.context.database_context_abc</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| </ul> |  | ||||||
| </div> |  | ||||||
| <div class="section" id="submodules"> |  | ||||||
| <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |  | ||||||
| </div> |  | ||||||
| <div class="section" id="module-cpl.database.database_model"> |  | ||||||
| <span id="cpl-database-database-model"></span><h2>cpl.database.database_model<a class="headerlink" href="#module-cpl.database.database_model" title="Permalink to this headline">¶</a></h2> |  | ||||||
| </div> |  | ||||||
| <div class="section" id="module-cpl.database.database_settings"> |  | ||||||
| <span id="cpl-database-database-settings"></span><h2>cpl.database.database_settings<a class="headerlink" href="#module-cpl.database.database_settings" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.database.database_settings.DatabaseSettings"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.database.database_settings.</span></code><code class="sig-name descname"><span class="pre">DatabaseSettings</span></code><a class="headerlink" href="#cpl.database.database_settings.DatabaseSettings" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Bases: <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a></p> |  | ||||||
| <p>Represents settings for the database connection</p> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.database.database_settings.DatabaseSettings.auth_plugin"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">auth_plugin</span></code><a class="headerlink" href="#cpl.database.database_settings.DatabaseSettings.auth_plugin" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.database.database_settings.DatabaseSettings.case_sensitive"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">case_sensitive</span></code><a class="headerlink" href="#cpl.database.database_settings.DatabaseSettings.case_sensitive" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.database.database_settings.DatabaseSettings.connection_string"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">connection_string</span></code><a class="headerlink" href="#cpl.database.database_settings.DatabaseSettings.connection_string" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.database.database_settings.DatabaseSettings.credentials"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">credentials</span></code><a class="headerlink" href="#cpl.database.database_settings.DatabaseSettings.credentials" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.database.database_settings.DatabaseSettings.echo"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">echo</span></code><a class="headerlink" href="#cpl.database.database_settings.DatabaseSettings.echo" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.database.database_settings.DatabaseSettings.encoding"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">encoding</span></code><a class="headerlink" href="#cpl.database.database_settings.DatabaseSettings.encoding" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.database.database_settings.DatabaseSettings.from_dict"> |  | ||||||
| <code class="sig-name descname"><span class="pre">from_dict</span></code><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="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.database.database_settings.DatabaseSettings.from_dict" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Sets attributes from given dict</p> |  | ||||||
| <p>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| <div class="section" id="module-cpl.database.database_settings_name_enum"> |  | ||||||
| <span id="cpl-database-database-settings-name-enum"></span><h2>cpl.database.database_settings_name_enum<a class="headerlink" href="#module-cpl.database.database_settings_name_enum" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.database.database_settings_name_enum.</span></code><code class="sig-name descname"><span class="pre">DatabaseSettingsNameEnum</span></code><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.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.Enum</span></code></p> |  | ||||||
| <p>An enumeration.</p> |  | ||||||
| <dl class="py attribute"> |  | ||||||
| <dt id="cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum.auth_plugin"> |  | ||||||
| <code class="sig-name descname"><span class="pre">auth_plugin</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'AuthPlugin'</span></em><a class="headerlink" href="#cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum.auth_plugin" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py attribute"> |  | ||||||
| <dt id="cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum.case_sensitive"> |  | ||||||
| <code class="sig-name descname"><span class="pre">case_sensitive</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'CaseSensitive'</span></em><a class="headerlink" href="#cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum.case_sensitive" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py attribute"> |  | ||||||
| <dt id="cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum.connection_string"> |  | ||||||
| <code class="sig-name descname"><span class="pre">connection_string</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'ConnectionString'</span></em><a class="headerlink" href="#cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum.connection_string" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py attribute"> |  | ||||||
| <dt id="cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum.credentials"> |  | ||||||
| <code class="sig-name descname"><span class="pre">credentials</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Credentials'</span></em><a class="headerlink" href="#cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum.credentials" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py attribute"> |  | ||||||
| <dt id="cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum.echo"> |  | ||||||
| <code class="sig-name descname"><span class="pre">echo</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Echo'</span></em><a class="headerlink" href="#cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum.echo" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py attribute"> |  | ||||||
| <dt id="cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum.encoding"> |  | ||||||
| <code class="sig-name descname"><span class="pre">encoding</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Encoding'</span></em><a class="headerlink" href="#cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum.encoding" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| </div> |  | ||||||
|  |  | ||||||
|  |  | ||||||
|            </div> |  | ||||||
|             |  | ||||||
|           </div> |  | ||||||
|           <footer> |  | ||||||
|     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |  | ||||||
|         <a href="cpl.database.connection.html" class="btn btn-neutral float-right" title="cpl.database.connection" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |  | ||||||
|         <a href="cpl.console.html" class="btn btn-neutral float-left" title="cpl.console" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |  | ||||||
|     </div> |  | ||||||
|  |  | ||||||
|   <hr/> |  | ||||||
|  |  | ||||||
|   <div role="contentinfo"> |  | ||||||
|     <p> |  | ||||||
|         © Copyright 2021, Sven Heidemann. |  | ||||||
|  |  | ||||||
|     </p> |  | ||||||
|   </div> |  | ||||||
|      |  | ||||||
|      |  | ||||||
|      |  | ||||||
|     Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |  | ||||||
|      |  | ||||||
|     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |  | ||||||
|      |  | ||||||
|     provided by <a href="https://readthedocs.org">Read the Docs</a>.  |  | ||||||
|  |  | ||||||
| </footer> |  | ||||||
|         </div> |  | ||||||
|       </div> |  | ||||||
|  |  | ||||||
|     </section> |  | ||||||
|  |  | ||||||
|   </div> |  | ||||||
|    |  | ||||||
|  |  | ||||||
|   <script type="text/javascript"> |  | ||||||
|       jQuery(function () { |  | ||||||
|           SphinxRtdTheme.Navigation.enable(true); |  | ||||||
|       }); |  | ||||||
|   </script> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|      |  | ||||||
|     |  | ||||||
|  |  | ||||||
| </body> |  | ||||||
| </html> |  | ||||||
							
								
								
									
										543
									
								
								docs/build/html/cpl.dependency_injection.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										543
									
								
								docs/build/html/cpl.dependency_injection.html
									
									
									
									
										vendored
									
									
								
							| @@ -1,543 +0,0 @@ | |||||||
|  |  | ||||||
|  |  | ||||||
| <!DOCTYPE html> |  | ||||||
| <html class="writer-html5" lang="en" > |  | ||||||
| <head> |  | ||||||
|   <meta charset="utf-8" /> |  | ||||||
|    |  | ||||||
|   <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |  | ||||||
|    |  | ||||||
|   <title>cpl.dependency_injection — Common Python Library  documentation</title> |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |  | ||||||
|   <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <!--[if lt IE 9]> |  | ||||||
|     <script src="_static/js/html5shiv.min.js"></script> |  | ||||||
|   <![endif]--> |  | ||||||
|    |  | ||||||
|      |  | ||||||
|       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> |  | ||||||
|         <script src="_static/jquery.js"></script> |  | ||||||
|         <script src="_static/underscore.js"></script> |  | ||||||
|         <script src="_static/doctools.js"></script> |  | ||||||
|      |  | ||||||
|     <script type="text/javascript" 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.environment" href="cpl.environment.html" /> |  | ||||||
|     <link rel="prev" title="cpl.database.context" href="cpl.database.context.html" />  |  | ||||||
| </head> |  | ||||||
|  |  | ||||||
| <body class="wy-body-for-nav"> |  | ||||||
|  |  | ||||||
|     |  | ||||||
|   <div class="wy-grid-for-nav"> |  | ||||||
|      |  | ||||||
|     <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |  | ||||||
|       <div class="wy-side-scroll"> |  | ||||||
|         <div class="wy-side-nav-search" > |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
|             <a href="index.html" class="icon icon-home"> Common Python Library |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
|           </a> |  | ||||||
|  |  | ||||||
|            |  | ||||||
|              |  | ||||||
|              |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
| <div role="search"> |  | ||||||
|   <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |  | ||||||
|     <input type="text" name="q" placeholder="Search docs" /> |  | ||||||
|     <input type="hidden" name="check_keywords" value="yes" /> |  | ||||||
|     <input type="hidden" name="area" value="default" /> |  | ||||||
|   </form> |  | ||||||
| </div> |  | ||||||
|  |  | ||||||
|            |  | ||||||
|         </div> |  | ||||||
|  |  | ||||||
|          |  | ||||||
|         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |  | ||||||
|            |  | ||||||
|              |  | ||||||
|              |  | ||||||
|                |  | ||||||
|              |  | ||||||
|              |  | ||||||
|               <ul class="current"> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current"> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.database.html">cpl.database</a></li> |  | ||||||
| <li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.dependency_injection</a><ul> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.dependency_injection.service_collection">cpl.dependency_injection.service_collection</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.dependency_injection.service_collection_abc">cpl.dependency_injection.service_collection_abc</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.dependency_injection.service_descriptor">cpl.dependency_injection.service_descriptor</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.dependency_injection.service_lifetime_enum">cpl.dependency_injection.service_lifetime_enum</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.dependency_injection.service_provider">cpl.dependency_injection.service_provider</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.dependency_injection.service_provider_abc">cpl.dependency_injection.service_provider_abc</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.environment.html">cpl.environment</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.logging.html">cpl.logging</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li> |  | ||||||
| </ul> |  | ||||||
|  |  | ||||||
|              |  | ||||||
|            |  | ||||||
|         </div> |  | ||||||
|          |  | ||||||
|       </div> |  | ||||||
|     </nav> |  | ||||||
|  |  | ||||||
|     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |  | ||||||
|  |  | ||||||
|        |  | ||||||
|       <nav class="wy-nav-top" aria-label="top navigation"> |  | ||||||
|          |  | ||||||
|           <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |  | ||||||
|           <a href="index.html">Common Python Library</a> |  | ||||||
|          |  | ||||||
|       </nav> |  | ||||||
|  |  | ||||||
|  |  | ||||||
|       <div class="wy-nav-content"> |  | ||||||
|          |  | ||||||
|         <div class="rst-content"> |  | ||||||
|          |  | ||||||
|            |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
| <div role="navigation" aria-label="breadcrumbs navigation"> |  | ||||||
|  |  | ||||||
|   <ul class="wy-breadcrumbs"> |  | ||||||
|      |  | ||||||
|       <li><a href="index.html" class="icon icon-home"></a> »</li> |  | ||||||
|          |  | ||||||
|           <li><a href="cpl.html">API Reference</a> »</li> |  | ||||||
|          |  | ||||||
|       <li>cpl.dependency_injection</li> |  | ||||||
|      |  | ||||||
|      |  | ||||||
|       <li class="wy-breadcrumbs-aside"> |  | ||||||
|          |  | ||||||
|            |  | ||||||
|             <a href="_sources/cpl.dependency_injection.rst.txt" rel="nofollow"> View page source</a> |  | ||||||
|            |  | ||||||
|          |  | ||||||
|       </li> |  | ||||||
|      |  | ||||||
|   </ul> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <hr/> |  | ||||||
| </div> |  | ||||||
|           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |  | ||||||
|            <div itemprop="articleBody"> |  | ||||||
|              |  | ||||||
|   <div class="section" id="cpl-dependency-injection"> |  | ||||||
| <h1>cpl.dependency_injection<a class="headerlink" href="#cpl-dependency-injection" title="Permalink to this headline">¶</a></h1> |  | ||||||
| <div class="section" id="module-cpl.dependency_injection.service_collection"> |  | ||||||
| <span id="cpl-dependency-injection-service-collection"></span><h2>cpl.dependency_injection.service_collection<a class="headerlink" href="#module-cpl.dependency_injection.service_collection" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.dependency_injection.service_collection.ServiceCollection"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.dependency_injection.service_collection.</span></code><code class="sig-name descname"><span class="pre">ServiceCollection</span></code><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="n"><a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.dependency_injection.service_collection.ServiceCollection" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Bases: <a class="reference internal" href="#cpl.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p> |  | ||||||
| <p>Representation of the collection of services</p> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.dependency_injection.service_collection.ServiceCollection.add_db_context"> |  | ||||||
| <code class="sig-name descname"><span class="pre">add_db_context</span></code><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="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl.database.context.html#cpl.database.context.database_context_abc.DatabaseContextABC" title="cpl.database.context.database_context_abc.DatabaseContextABC"><span class="pre">cpl.database.context.database_context_abc.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="n"><a class="reference internal" href="cpl.database.html#cpl.database.database_settings.DatabaseSettings" title="cpl.database.database_settings.DatabaseSettings"><span class="pre">cpl.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.dependency_injection.service_collection.ServiceCollection.add_db_context" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Adds database context</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>db_context: Type[<a class="reference internal" href="cpl.database.context.html#cpl.database.context.database_context_abc.DatabaseContextABC" title="cpl.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database context</p> |  | ||||||
| </dd> |  | ||||||
| <dt>db_settings: <a class="reference internal" href="cpl.database.html#cpl.database.database_settings.DatabaseSettings" title="cpl.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.database_settings.DatabaseSettings</span></code></a></dt><dd><p>Database settings</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.dependency_injection.service_collection.ServiceCollection.add_logging"> |  | ||||||
| <code class="sig-name descname"><span class="pre">add_logging</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.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 id="cpl.dependency_injection.service_collection.ServiceCollection.add_scoped"> |  | ||||||
| <code class="sig-name descname"><span class="pre">add_scoped</span></code><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="n"><span class="pre">Type</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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></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.dependency_injection.service_collection.ServiceCollection.add_scoped" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Adds a service with scoped lifetime</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>service_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></dt><dd><p>Type of the service</p> |  | ||||||
| </dd> |  | ||||||
| <dt>service: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>Object of the service</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.dependency_injection.service_collection.ServiceCollection.add_singleton"> |  | ||||||
| <code class="sig-name descname"><span class="pre">add_singleton</span></code><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="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">,</span> </span><span class="pre">object</span><span class="p"><span class="pre">]</span></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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">,</span> </span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></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.dependency_injection.service_collection.ServiceCollection.add_singleton" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Adds a service with singleton lifetime</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>service_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></dt><dd><p>Type of the service</p> |  | ||||||
| </dd> |  | ||||||
| <dt>service: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>Object of the service</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.dependency_injection.service_collection.ServiceCollection.add_transient"> |  | ||||||
| <code class="sig-name descname"><span class="pre">add_transient</span></code><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="n"><span class="pre">type</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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></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.dependency_injection.service_collection.ServiceCollection.add_transient" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Adds a service with transient lifetime</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>service_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></dt><dd><p>Type of the service</p> |  | ||||||
| </dd> |  | ||||||
| <dt>service: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>Object of the service</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.dependency_injection.service_collection.ServiceCollection.build_service_provider"> |  | ||||||
| <code class="sig-name descname"><span class="pre">build_service_provider</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></a><a class="headerlink" href="#cpl.dependency_injection.service_collection.ServiceCollection.build_service_provider" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Creates instance of the service provider</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><p>Object of type <a class="reference internal" href="#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| <div class="section" id="module-cpl.dependency_injection.service_collection_abc"> |  | ||||||
| <span id="cpl-dependency-injection-service-collection-abc"></span><h2>cpl.dependency_injection.service_collection_abc<a class="headerlink" href="#module-cpl.dependency_injection.service_collection_abc" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.dependency_injection.service_collection_abc.ServiceCollectionABC"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.dependency_injection.service_collection_abc.</span></code><code class="sig-name descname"><span class="pre">ServiceCollectionABC</span></code><a class="headerlink" href="#cpl.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.ABC</span></code></p> |  | ||||||
| <p>ABC for the class <a class="reference internal" href="#cpl.dependency_injection.service_collection.ServiceCollection" title="cpl.dependency_injection.service_collection.ServiceCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.dependency_injection.service_collection.ServiceCollection</span></code></a></p> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.dependency_injection.service_collection_abc.ServiceCollectionABC.add_db_context"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_db_context</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_context</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl.database.context.html#cpl.database.context.database_context_abc.DatabaseContextABC" title="cpl.database.context.database_context_abc.DatabaseContextABC"><span class="pre">cpl.database.context.database_context_abc.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="n"><a class="reference internal" href="cpl.database.html#cpl.database.database_settings.DatabaseSettings" title="cpl.database.database_settings.DatabaseSettings"><span class="pre">cpl.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.dependency_injection.service_collection_abc.ServiceCollectionABC.add_db_context" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Adds database context</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>db_context: Type[<a class="reference internal" href="cpl.database.context.html#cpl.database.context.database_context_abc.DatabaseContextABC" title="cpl.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database context</p> |  | ||||||
| </dd> |  | ||||||
| <dt>db_settings: <a class="reference internal" href="cpl.database.html#cpl.database.database_settings.DatabaseSettings" title="cpl.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.database_settings.DatabaseSettings</span></code></a></dt><dd><p>Database settings</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.dependency_injection.service_collection_abc.ServiceCollectionABC.add_logging"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_logging</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.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 id="cpl.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_scoped</span></code><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="n"><span class="pre">Type</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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">]</span></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.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Adds a service with scoped lifetime</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>service_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></dt><dd><p>Type of the service</p> |  | ||||||
| </dd> |  | ||||||
| <dt>service: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>Object of the service</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_singleton</span></code><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="n"><span class="pre">Type</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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">]</span></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.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Adds a service with singleton lifetime</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>service_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></dt><dd><p>Type of the service</p> |  | ||||||
| </dd> |  | ||||||
| <dt>service: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>Object of the service</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_transient</span></code><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="n"><span class="pre">Type</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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">]</span></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.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Adds a service with transient lifetime</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>service_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></dt><dd><p>Type of the service</p> |  | ||||||
| </dd> |  | ||||||
| <dt>service: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>Object of the service</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.dependency_injection.service_collection_abc.ServiceCollectionABC.build_service_provider"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">build_service_provider</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></a><a class="headerlink" href="#cpl.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> |  | ||||||
| <blockquote> |  | ||||||
| <div><p>Object of type <a class="reference internal" href="#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| <div class="section" id="module-cpl.dependency_injection.service_descriptor"> |  | ||||||
| <span id="cpl-dependency-injection-service-descriptor"></span><h2>cpl.dependency_injection.service_descriptor<a class="headerlink" href="#module-cpl.dependency_injection.service_descriptor" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.dependency_injection.service_descriptor.ServiceDescriptor"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.dependency_injection.service_descriptor.</span></code><code class="sig-name descname"><span class="pre">ServiceDescriptor</span></code><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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">,</span> </span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></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="n"><a class="reference internal" href="#cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><span class="pre">cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.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> |  | ||||||
| <blockquote> |  | ||||||
| <div><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.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum</span></code></a></dt><dd><p>Lifetime of the service</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.dependency_injection.service_descriptor.ServiceDescriptor.implementation"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">implementation</span></code><a class="headerlink" href="#cpl.dependency_injection.service_descriptor.ServiceDescriptor.implementation" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.dependency_injection.service_descriptor.ServiceDescriptor.lifetime"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">lifetime</span></code><a class="headerlink" href="#cpl.dependency_injection.service_descriptor.ServiceDescriptor.lifetime" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.dependency_injection.service_descriptor.ServiceDescriptor.service_type"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">service_type</span></code><a class="headerlink" href="#cpl.dependency_injection.service_descriptor.ServiceDescriptor.service_type" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| <div class="section" id="module-cpl.dependency_injection.service_lifetime_enum"> |  | ||||||
| <span id="cpl-dependency-injection-service-lifetime-enum"></span><h2>cpl.dependency_injection.service_lifetime_enum<a class="headerlink" href="#module-cpl.dependency_injection.service_lifetime_enum" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.dependency_injection.service_lifetime_enum.</span></code><code class="sig-name descname"><span class="pre">ServiceLifetimeEnum</span></code><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.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.Enum</span></code></p> |  | ||||||
| <p>An enumeration.</p> |  | ||||||
| <dl class="py attribute"> |  | ||||||
| <dt id="cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.scoped"> |  | ||||||
| <code class="sig-name descname"><span class="pre">scoped</span></code><em class="property"> <span class="pre">=</span> <span class="pre">1</span></em><a class="headerlink" href="#cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.scoped" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py attribute"> |  | ||||||
| <dt id="cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.singleton"> |  | ||||||
| <code class="sig-name descname"><span class="pre">singleton</span></code><em class="property"> <span class="pre">=</span> <span class="pre">0</span></em><a class="headerlink" href="#cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.singleton" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py attribute"> |  | ||||||
| <dt id="cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.transient"> |  | ||||||
| <code class="sig-name descname"><span class="pre">transient</span></code><em class="property"> <span class="pre">=</span> <span class="pre">2</span></em><a class="headerlink" href="#cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.transient" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| <div class="section" id="module-cpl.dependency_injection.service_provider"> |  | ||||||
| <span id="cpl-dependency-injection-service-provider"></span><h2>cpl.dependency_injection.service_provider<a class="headerlink" href="#module-cpl.dependency_injection.service_provider" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.dependency_injection.service_provider.ServiceProvider"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.dependency_injection.service_provider.</span></code><code class="sig-name descname"><span class="pre">ServiceProvider</span></code><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="n"><span class="pre">list</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="n"><a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl.configuration.configuration_abc.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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl.database.context.html#cpl.database.context.database_context_abc.DatabaseContextABC" title="cpl.database.context.database_context_abc.DatabaseContextABC"><span class="pre">cpl.database.context.database_context_abc.DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.dependency_injection.service_provider.ServiceProvider" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Bases: <a class="reference internal" href="#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p> |  | ||||||
| <p>Provider for the services</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>service_descriptors: list[<a class="reference internal" href="#cpl.dependency_injection.service_descriptor.ServiceDescriptor" title="cpl.dependency_injection.service_descriptor.ServiceDescriptor"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.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.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></code></a></dt><dd><p>CPL Configuration</p> |  | ||||||
| </dd> |  | ||||||
| <dt>db_context: Optional[<a class="reference internal" href="cpl.database.context.html#cpl.database.context.database_context_abc.DatabaseContextABC" title="cpl.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database representation</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.dependency_injection.service_provider.ServiceProvider.build_service"> |  | ||||||
| <code class="sig-name descname"><span class="pre">build_service</span></code><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="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span> → <span class="pre">object</span><a class="headerlink" href="#cpl.dependency_injection.service_provider.ServiceProvider.build_service" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Creates instance of given type</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></dt><dd><p>The type of the searched instance</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| <blockquote> |  | ||||||
| <div><p>Object of the given type</p> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.dependency_injection.service_provider.ServiceProvider.get_service"> |  | ||||||
| <code class="sig-name descname"><span class="pre">get_service</span></code><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="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span> → <span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl.dependency_injection.service_provider.ServiceProvider.get_service" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Returns instance of given type</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></dt><dd><p>The type of the searched instance</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| <blockquote> |  | ||||||
| <div><p>Object of type Optional[Callable[<code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code>]]</p> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| <div class="section" id="module-cpl.dependency_injection.service_provider_abc"> |  | ||||||
| <span id="cpl-dependency-injection-service-provider-abc"></span><h2>cpl.dependency_injection.service_provider_abc<a class="headerlink" href="#module-cpl.dependency_injection.service_provider_abc" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.dependency_injection.service_provider_abc.</span></code><code class="sig-name descname"><span class="pre">ServiceProviderABC</span></code><a class="headerlink" href="#cpl.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.ABC</span></code></p> |  | ||||||
| <p>ABC for the class <a class="reference internal" href="#cpl.dependency_injection.service_provider.ServiceProvider" title="cpl.dependency_injection.service_provider.ServiceProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.dependency_injection.service_provider.ServiceProvider</span></code></a></p> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.dependency_injection.service_provider_abc.ServiceProviderABC.build_service"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">build_service</span></code><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="n"><span class="pre">Type</span></span></em><span class="sig-paren">)</span> → <span class="pre">object</span><a class="headerlink" href="#cpl.dependency_injection.service_provider_abc.ServiceProviderABC.build_service" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Creates instance of given type</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></dt><dd><p>The type of the searched instance</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| <blockquote> |  | ||||||
| <div><p>Object of the given type</p> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.dependency_injection.service_provider_abc.ServiceProviderABC.get_service"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">get_service</span></code><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="n"><span class="pre">Type</span></span></em><span class="sig-paren">)</span> → <span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl.dependency_injection.service_provider_abc.ServiceProviderABC.get_service" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Returns instance of given type</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></dt><dd><p>The type of the searched instance</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| <blockquote> |  | ||||||
| <div><p>Object of type Optional[Callable[<code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code>]]</p> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| </div> |  | ||||||
|  |  | ||||||
|  |  | ||||||
|            </div> |  | ||||||
|             |  | ||||||
|           </div> |  | ||||||
|           <footer> |  | ||||||
|     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |  | ||||||
|         <a href="cpl.environment.html" class="btn btn-neutral float-right" title="cpl.environment" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |  | ||||||
|         <a href="cpl.database.context.html" class="btn btn-neutral float-left" title="cpl.database.context" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |  | ||||||
|     </div> |  | ||||||
|  |  | ||||||
|   <hr/> |  | ||||||
|  |  | ||||||
|   <div role="contentinfo"> |  | ||||||
|     <p> |  | ||||||
|         © Copyright 2021, Sven Heidemann. |  | ||||||
|  |  | ||||||
|     </p> |  | ||||||
|   </div> |  | ||||||
|      |  | ||||||
|      |  | ||||||
|      |  | ||||||
|     Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |  | ||||||
|      |  | ||||||
|     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |  | ||||||
|      |  | ||||||
|     provided by <a href="https://readthedocs.org">Read the Docs</a>.  |  | ||||||
|  |  | ||||||
| </footer> |  | ||||||
|         </div> |  | ||||||
|       </div> |  | ||||||
|  |  | ||||||
|     </section> |  | ||||||
|  |  | ||||||
|   </div> |  | ||||||
|    |  | ||||||
|  |  | ||||||
|   <script type="text/javascript"> |  | ||||||
|       jQuery(function () { |  | ||||||
|           SphinxRtdTheme.Navigation.enable(true); |  | ||||||
|       }); |  | ||||||
|   </script> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|      |  | ||||||
|     |  | ||||||
|  |  | ||||||
| </body> |  | ||||||
| </html> |  | ||||||
							
								
								
									
										421
									
								
								docs/build/html/cpl.environment.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										421
									
								
								docs/build/html/cpl.environment.html
									
									
									
									
										vendored
									
									
								
							| @@ -1,421 +0,0 @@ | |||||||
|  |  | ||||||
|  |  | ||||||
| <!DOCTYPE html> |  | ||||||
| <html class="writer-html5" lang="en" > |  | ||||||
| <head> |  | ||||||
|   <meta charset="utf-8" /> |  | ||||||
|    |  | ||||||
|   <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |  | ||||||
|    |  | ||||||
|   <title>cpl.environment — Common Python Library  documentation</title> |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |  | ||||||
|   <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <!--[if lt IE 9]> |  | ||||||
|     <script src="_static/js/html5shiv.min.js"></script> |  | ||||||
|   <![endif]--> |  | ||||||
|    |  | ||||||
|      |  | ||||||
|       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> |  | ||||||
|         <script src="_static/jquery.js"></script> |  | ||||||
|         <script src="_static/underscore.js"></script> |  | ||||||
|         <script src="_static/doctools.js"></script> |  | ||||||
|      |  | ||||||
|     <script type="text/javascript" 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.logging" href="cpl.logging.html" /> |  | ||||||
|     <link rel="prev" title="cpl.dependency_injection" href="cpl.dependency_injection.html" />  |  | ||||||
| </head> |  | ||||||
|  |  | ||||||
| <body class="wy-body-for-nav"> |  | ||||||
|  |  | ||||||
|     |  | ||||||
|   <div class="wy-grid-for-nav"> |  | ||||||
|      |  | ||||||
|     <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |  | ||||||
|       <div class="wy-side-scroll"> |  | ||||||
|         <div class="wy-side-nav-search" > |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
|             <a href="index.html" class="icon icon-home"> Common Python Library |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
|           </a> |  | ||||||
|  |  | ||||||
|            |  | ||||||
|              |  | ||||||
|              |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
| <div role="search"> |  | ||||||
|   <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |  | ||||||
|     <input type="text" name="q" placeholder="Search docs" /> |  | ||||||
|     <input type="hidden" name="check_keywords" value="yes" /> |  | ||||||
|     <input type="hidden" name="area" value="default" /> |  | ||||||
|   </form> |  | ||||||
| </div> |  | ||||||
|  |  | ||||||
|            |  | ||||||
|         </div> |  | ||||||
|  |  | ||||||
|          |  | ||||||
|         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |  | ||||||
|            |  | ||||||
|              |  | ||||||
|              |  | ||||||
|                |  | ||||||
|              |  | ||||||
|              |  | ||||||
|               <ul class="current"> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current"> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.database.html">cpl.database</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a></li> |  | ||||||
| <li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.environment</a><ul> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.environment.application_environment">cpl.environment.application_environment</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.environment.application_environment_abc">cpl.environment.application_environment_abc</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.environment.environment_name_enum">cpl.environment.environment_name_enum</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.logging.html">cpl.logging</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li> |  | ||||||
| </ul> |  | ||||||
|  |  | ||||||
|              |  | ||||||
|            |  | ||||||
|         </div> |  | ||||||
|          |  | ||||||
|       </div> |  | ||||||
|     </nav> |  | ||||||
|  |  | ||||||
|     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |  | ||||||
|  |  | ||||||
|        |  | ||||||
|       <nav class="wy-nav-top" aria-label="top navigation"> |  | ||||||
|          |  | ||||||
|           <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |  | ||||||
|           <a href="index.html">Common Python Library</a> |  | ||||||
|          |  | ||||||
|       </nav> |  | ||||||
|  |  | ||||||
|  |  | ||||||
|       <div class="wy-nav-content"> |  | ||||||
|          |  | ||||||
|         <div class="rst-content"> |  | ||||||
|          |  | ||||||
|            |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
| <div role="navigation" aria-label="breadcrumbs navigation"> |  | ||||||
|  |  | ||||||
|   <ul class="wy-breadcrumbs"> |  | ||||||
|      |  | ||||||
|       <li><a href="index.html" class="icon icon-home"></a> »</li> |  | ||||||
|          |  | ||||||
|           <li><a href="cpl.html">API Reference</a> »</li> |  | ||||||
|          |  | ||||||
|       <li>cpl.environment</li> |  | ||||||
|      |  | ||||||
|      |  | ||||||
|       <li class="wy-breadcrumbs-aside"> |  | ||||||
|          |  | ||||||
|            |  | ||||||
|             <a href="_sources/cpl.environment.rst.txt" rel="nofollow"> View page source</a> |  | ||||||
|            |  | ||||||
|          |  | ||||||
|       </li> |  | ||||||
|      |  | ||||||
|   </ul> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <hr/> |  | ||||||
| </div> |  | ||||||
|           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |  | ||||||
|            <div itemprop="articleBody"> |  | ||||||
|              |  | ||||||
|   <div class="section" id="cpl-environment"> |  | ||||||
| <h1>cpl.environment<a class="headerlink" href="#cpl-environment" title="Permalink to this headline">¶</a></h1> |  | ||||||
| <div class="section" id="module-cpl.environment.application_environment"> |  | ||||||
| <span id="cpl-environment-application-environment"></span><h2>cpl.environment.application_environment<a class="headerlink" href="#module-cpl.environment.application_environment" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.environment.application_environment.ApplicationEnvironment"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.environment.application_environment.</span></code><code class="sig-name descname"><span class="pre">ApplicationEnvironment</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="pre">name:</span> <span class="pre">cpl.environment.environment_name_enum.EnvironmentNameEnum</span> <span class="pre">=</span> <span class="pre"><EnvironmentNameEnum.production:</span> <span class="pre">'production'></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.environment.application_environment.ApplicationEnvironment" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Bases: <a class="reference internal" href="#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></code></a></p> |  | ||||||
| <p>Represents environment of the application</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><p>name: <a class="reference internal" href="#cpl.environment.environment_name_enum.EnvironmentNameEnum" title="cpl.environment.environment_name_enum.EnvironmentNameEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.environment.environment_name_enum.EnvironmentNameEnum</span></code></a></p> |  | ||||||
| </div></blockquote> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment.ApplicationEnvironment.application_name"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">application_name</span></code><a class="headerlink" href="#cpl.environment.application_environment.ApplicationEnvironment.application_name" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment.ApplicationEnvironment.customer"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">customer</span></code><a class="headerlink" href="#cpl.environment.application_environment.ApplicationEnvironment.customer" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment.ApplicationEnvironment.date_time_now"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">date_time_now</span></code><a class="headerlink" href="#cpl.environment.application_environment.ApplicationEnvironment.date_time_now" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment.ApplicationEnvironment.end_time"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">end_time</span></code><a class="headerlink" href="#cpl.environment.application_environment.ApplicationEnvironment.end_time" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment.ApplicationEnvironment.environment_name"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">environment_name</span></code><a class="headerlink" href="#cpl.environment.application_environment.ApplicationEnvironment.environment_name" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment.ApplicationEnvironment.host_name"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">host_name</span></code><a class="headerlink" href="#cpl.environment.application_environment.ApplicationEnvironment.host_name" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment.ApplicationEnvironment.runtime_directory"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">runtime_directory</span></code><a class="headerlink" href="#cpl.environment.application_environment.ApplicationEnvironment.runtime_directory" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment.ApplicationEnvironment.set_runtime_directory"> |  | ||||||
| <code class="sig-name descname"><span class="pre">set_runtime_directory</span></code><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="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.environment.application_environment.ApplicationEnvironment.set_runtime_directory" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Sets the current runtime directory</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>runtime_directory: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Path of the runtime directory</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment.ApplicationEnvironment.set_working_directory"> |  | ||||||
| <code class="sig-name descname"><span class="pre">set_working_directory</span></code><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="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.environment.application_environment.ApplicationEnvironment.set_working_directory" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Sets the current working directory</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>working_directory: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Path of the current working directory</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment.ApplicationEnvironment.start_time"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">start_time</span></code><a class="headerlink" href="#cpl.environment.application_environment.ApplicationEnvironment.start_time" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment.ApplicationEnvironment.working_directory"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">working_directory</span></code><a class="headerlink" href="#cpl.environment.application_environment.ApplicationEnvironment.working_directory" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| <div class="section" id="module-cpl.environment.application_environment_abc"> |  | ||||||
| <span id="cpl-environment-application-environment-abc"></span><h2>cpl.environment.application_environment_abc<a class="headerlink" href="#module-cpl.environment.application_environment_abc" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.environment.application_environment_abc.</span></code><code class="sig-name descname"><span class="pre">ApplicationEnvironmentABC</span></code><a class="headerlink" href="#cpl.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.ABC</span></code></p> |  | ||||||
| <p>ABC of the class <a class="reference internal" href="#cpl.environment.application_environment.ApplicationEnvironment" title="cpl.environment.application_environment.ApplicationEnvironment"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.environment.application_environment.ApplicationEnvironment</span></code></a></p> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment_abc.ApplicationEnvironmentABC.application_name"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">application_name</span></code><a class="headerlink" href="#cpl.environment.application_environment_abc.ApplicationEnvironmentABC.application_name" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment_abc.ApplicationEnvironmentABC.customer"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">customer</span></code><a class="headerlink" href="#cpl.environment.application_environment_abc.ApplicationEnvironmentABC.customer" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment_abc.ApplicationEnvironmentABC.date_time_now"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">date_time_now</span></code><a class="headerlink" href="#cpl.environment.application_environment_abc.ApplicationEnvironmentABC.date_time_now" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment_abc.ApplicationEnvironmentABC.end_time"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">end_time</span></code><a class="headerlink" href="#cpl.environment.application_environment_abc.ApplicationEnvironmentABC.end_time" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment_abc.ApplicationEnvironmentABC.environment_name"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">environment_name</span></code><a class="headerlink" href="#cpl.environment.application_environment_abc.ApplicationEnvironmentABC.environment_name" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment_abc.ApplicationEnvironmentABC.host_name"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">host_name</span></code><a class="headerlink" href="#cpl.environment.application_environment_abc.ApplicationEnvironmentABC.host_name" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment_abc.ApplicationEnvironmentABC.runtime_directory"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">runtime_directory</span></code><a class="headerlink" href="#cpl.environment.application_environment_abc.ApplicationEnvironmentABC.runtime_directory" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment_abc.ApplicationEnvironmentABC.set_runtime_directory"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">set_runtime_directory</span></code><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="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.environment.application_environment_abc.ApplicationEnvironmentABC.set_runtime_directory" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Sets the current runtime directory</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>runtime_directory: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Path of the runtime directory</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment_abc.ApplicationEnvironmentABC.set_working_directory"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">set_working_directory</span></code><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="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.environment.application_environment_abc.ApplicationEnvironmentABC.set_working_directory" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Sets the current working directory</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>working_directory: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Path of the current working directory</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment_abc.ApplicationEnvironmentABC.start_time"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">start_time</span></code><a class="headerlink" href="#cpl.environment.application_environment_abc.ApplicationEnvironmentABC.start_time" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.environment.application_environment_abc.ApplicationEnvironmentABC.working_directory"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">working_directory</span></code><a class="headerlink" href="#cpl.environment.application_environment_abc.ApplicationEnvironmentABC.working_directory" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| <div class="section" id="module-cpl.environment.environment_name_enum"> |  | ||||||
| <span id="cpl-environment-environment-name-enum"></span><h2>cpl.environment.environment_name_enum<a class="headerlink" href="#module-cpl.environment.environment_name_enum" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.environment.environment_name_enum.EnvironmentNameEnum"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.environment.environment_name_enum.</span></code><code class="sig-name descname"><span class="pre">EnvironmentNameEnum</span></code><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.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.Enum</span></code></p> |  | ||||||
| <p>An enumeration.</p> |  | ||||||
| <dl class="py attribute"> |  | ||||||
| <dt id="cpl.environment.environment_name_enum.EnvironmentNameEnum.development"> |  | ||||||
| <code class="sig-name descname"><span class="pre">development</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'development'</span></em><a class="headerlink" href="#cpl.environment.environment_name_enum.EnvironmentNameEnum.development" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py attribute"> |  | ||||||
| <dt id="cpl.environment.environment_name_enum.EnvironmentNameEnum.production"> |  | ||||||
| <code class="sig-name descname"><span class="pre">production</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'production'</span></em><a class="headerlink" href="#cpl.environment.environment_name_enum.EnvironmentNameEnum.production" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py attribute"> |  | ||||||
| <dt id="cpl.environment.environment_name_enum.EnvironmentNameEnum.staging"> |  | ||||||
| <code class="sig-name descname"><span class="pre">staging</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'staging'</span></em><a class="headerlink" href="#cpl.environment.environment_name_enum.EnvironmentNameEnum.staging" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py attribute"> |  | ||||||
| <dt id="cpl.environment.environment_name_enum.EnvironmentNameEnum.testing"> |  | ||||||
| <code class="sig-name descname"><span class="pre">testing</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'testing'</span></em><a class="headerlink" href="#cpl.environment.environment_name_enum.EnvironmentNameEnum.testing" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| </div> |  | ||||||
|  |  | ||||||
|  |  | ||||||
|            </div> |  | ||||||
|             |  | ||||||
|           </div> |  | ||||||
|           <footer> |  | ||||||
|     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |  | ||||||
|         <a href="cpl.logging.html" class="btn btn-neutral float-right" title="cpl.logging" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |  | ||||||
|         <a href="cpl.dependency_injection.html" class="btn btn-neutral float-left" title="cpl.dependency_injection" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |  | ||||||
|     </div> |  | ||||||
|  |  | ||||||
|   <hr/> |  | ||||||
|  |  | ||||||
|   <div role="contentinfo"> |  | ||||||
|     <p> |  | ||||||
|         © Copyright 2021, Sven Heidemann. |  | ||||||
|  |  | ||||||
|     </p> |  | ||||||
|   </div> |  | ||||||
|      |  | ||||||
|      |  | ||||||
|      |  | ||||||
|     Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |  | ||||||
|      |  | ||||||
|     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |  | ||||||
|      |  | ||||||
|     provided by <a href="https://readthedocs.org">Read the Docs</a>.  |  | ||||||
|  |  | ||||||
| </footer> |  | ||||||
|         </div> |  | ||||||
|       </div> |  | ||||||
|  |  | ||||||
|     </section> |  | ||||||
|  |  | ||||||
|   </div> |  | ||||||
|    |  | ||||||
|  |  | ||||||
|   <script type="text/javascript"> |  | ||||||
|       jQuery(function () { |  | ||||||
|           SphinxRtdTheme.Navigation.enable(true); |  | ||||||
|       }); |  | ||||||
|   </script> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|      |  | ||||||
|     |  | ||||||
|  |  | ||||||
| </body> |  | ||||||
| </html> |  | ||||||
							
								
								
									
										309
									
								
								docs/build/html/cpl.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										309
									
								
								docs/build/html/cpl.html
									
									
									
									
										vendored
									
									
								
							| @@ -1,309 +0,0 @@ | |||||||
|  |  | ||||||
|  |  | ||||||
| <!DOCTYPE html> |  | ||||||
| <html class="writer-html5" lang="en" > |  | ||||||
| <head> |  | ||||||
|   <meta charset="utf-8" /> |  | ||||||
|    |  | ||||||
|   <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |  | ||||||
|    |  | ||||||
|   <title>API Reference — Common Python Library  documentation</title> |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |  | ||||||
|   <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <!--[if lt IE 9]> |  | ||||||
|     <script src="_static/js/html5shiv.min.js"></script> |  | ||||||
|   <![endif]--> |  | ||||||
|    |  | ||||||
|      |  | ||||||
|       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> |  | ||||||
|         <script src="_static/jquery.js"></script> |  | ||||||
|         <script src="_static/underscore.js"></script> |  | ||||||
|         <script src="_static/doctools.js"></script> |  | ||||||
|      |  | ||||||
|     <script type="text/javascript" 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.application" href="cpl.application.html" /> |  | ||||||
|     <link rel="prev" title="Setting up the local environment and workspace" href="setup.html" />  |  | ||||||
| </head> |  | ||||||
|  |  | ||||||
| <body class="wy-body-for-nav"> |  | ||||||
|  |  | ||||||
|     |  | ||||||
|   <div class="wy-grid-for-nav"> |  | ||||||
|      |  | ||||||
|     <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |  | ||||||
|       <div class="wy-side-scroll"> |  | ||||||
|         <div class="wy-side-nav-search" > |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
|             <a href="index.html" class="icon icon-home"> Common Python Library |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
|           </a> |  | ||||||
|  |  | ||||||
|            |  | ||||||
|              |  | ||||||
|              |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
| <div role="search"> |  | ||||||
|   <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |  | ||||||
|     <input type="text" name="q" placeholder="Search docs" /> |  | ||||||
|     <input type="hidden" name="check_keywords" value="yes" /> |  | ||||||
|     <input type="hidden" name="area" value="default" /> |  | ||||||
|   </form> |  | ||||||
| </div> |  | ||||||
|  |  | ||||||
|            |  | ||||||
|         </div> |  | ||||||
|  |  | ||||||
|          |  | ||||||
|         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |  | ||||||
|            |  | ||||||
|              |  | ||||||
|              |  | ||||||
|                |  | ||||||
|              |  | ||||||
|              |  | ||||||
|               <ul class="current"> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a><ul> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.database.html">cpl.database</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.environment.html">cpl.environment</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.logging.html">cpl.logging</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li> |  | ||||||
| </ul> |  | ||||||
|  |  | ||||||
|              |  | ||||||
|            |  | ||||||
|         </div> |  | ||||||
|          |  | ||||||
|       </div> |  | ||||||
|     </nav> |  | ||||||
|  |  | ||||||
|     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |  | ||||||
|  |  | ||||||
|        |  | ||||||
|       <nav class="wy-nav-top" aria-label="top navigation"> |  | ||||||
|          |  | ||||||
|           <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |  | ||||||
|           <a href="index.html">Common Python Library</a> |  | ||||||
|          |  | ||||||
|       </nav> |  | ||||||
|  |  | ||||||
|  |  | ||||||
|       <div class="wy-nav-content"> |  | ||||||
|          |  | ||||||
|         <div class="rst-content"> |  | ||||||
|          |  | ||||||
|            |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
| <div role="navigation" aria-label="breadcrumbs navigation"> |  | ||||||
|  |  | ||||||
|   <ul class="wy-breadcrumbs"> |  | ||||||
|      |  | ||||||
|       <li><a href="index.html" class="icon icon-home"></a> »</li> |  | ||||||
|          |  | ||||||
|       <li>API Reference</li> |  | ||||||
|      |  | ||||||
|      |  | ||||||
|       <li class="wy-breadcrumbs-aside"> |  | ||||||
|          |  | ||||||
|            |  | ||||||
|             <a href="_sources/cpl.rst.txt" rel="nofollow"> View page source</a> |  | ||||||
|            |  | ||||||
|          |  | ||||||
|       </li> |  | ||||||
|      |  | ||||||
|   </ul> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <hr/> |  | ||||||
| </div> |  | ||||||
|           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |  | ||||||
|            <div itemprop="articleBody"> |  | ||||||
|              |  | ||||||
|   <div class="section" id="api-reference"> |  | ||||||
| <h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h1> |  | ||||||
| <div class="toctree-wrapper compound"> |  | ||||||
| <ul> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.application.html">cpl.application</a><ul> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_abc">cpl.application.application_abc</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_builder">cpl.application.application_builder</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.application.html#module-cpl.application.application_builder_abc">cpl.application.application_builder_abc</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.application.html#module-cpl.application.startup_abc">cpl.application.startup_abc</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a><ul> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration">cpl.configuration.configuration</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration_abc">cpl.configuration.configuration_abc</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration_model_abc">cpl.configuration.configuration_model_abc</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.configuration_variable_name_enum">cpl.configuration.configuration_variable_name_enum</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html#module-cpl.configuration.console_argument">cpl.configuration.console_argument</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.console.html">cpl.console</a><ul> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.background_color_enum">cpl.console.background_color_enum</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.console">cpl.console.console</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.console_call">cpl.console.console_call</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.foreground_color_enum">cpl.console.foreground_color_enum</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.console.html#module-cpl.console.spinner_thread">cpl.console.spinner_thread</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.database.html">cpl.database</a><ul> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.database.connection.html">cpl.database.connection</a><ul> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="cpl.database.connection.html#module-cpl.database.connection.database_connection">cpl.database.connection.database_connection</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="cpl.database.connection.html#module-cpl.database.connection.database_connection_abc">cpl.database.connection.database_connection_abc</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.database.context.html">cpl.database.context</a><ul> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="cpl.database.context.html#module-cpl.database.context.database_context">cpl.database.context.database_context</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="cpl.database.context.html#module-cpl.database.context.database_context_abc">cpl.database.context.database_context_abc</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.database.html#submodules">Submodules</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_model">cpl.database.database_model</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings">cpl.database.database_settings</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.database.html#module-cpl.database.database_settings_name_enum">cpl.database.database_settings_name_enum</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a><ul> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_collection">cpl.dependency_injection.service_collection</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_collection_abc">cpl.dependency_injection.service_collection_abc</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_descriptor">cpl.dependency_injection.service_descriptor</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_lifetime_enum">cpl.dependency_injection.service_lifetime_enum</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_provider">cpl.dependency_injection.service_provider</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html#module-cpl.dependency_injection.service_provider_abc">cpl.dependency_injection.service_provider_abc</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.environment.html">cpl.environment</a><ul> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.environment.html#module-cpl.environment.application_environment">cpl.environment.application_environment</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.environment.html#module-cpl.environment.application_environment_abc">cpl.environment.application_environment_abc</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.environment.html#module-cpl.environment.environment_name_enum">cpl.environment.environment_name_enum</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.logging.html">cpl.logging</a><ul> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logger_abc">cpl.logging.logger_abc</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logger_service">cpl.logging.logger_service</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logging_level_enum">cpl.logging.logging_level_enum</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logging_settings">cpl.logging.logging_settings</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.logging.html#module-cpl.logging.logging_settings_name_enum">cpl.logging.logging_settings_name_enum</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a><ul> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email">cpl.mailing.email</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_abc">cpl.mailing.email_client_abc</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_service">cpl.mailing.email_client_service</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_settings">cpl.mailing.email_client_settings</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html#module-cpl.mailing.email_client_settings_name_enum">cpl.mailing.email_client_settings_name_enum</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.time.html">cpl.time</a><ul> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.time.html#module-cpl.time.time_format_settings">cpl.time.time_format_settings</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.time.html#module-cpl.time.time_format_settings_names_enum">cpl.time.time_format_settings_names_enum</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.utils.html">cpl.utils</a><ul> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html#module-cpl.utils.credential_manager">cpl.utils.credential_manager</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html#module-cpl.utils.pip">cpl.utils.pip</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html#module-cpl.utils.string">cpl.utils.string</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| </ul> |  | ||||||
| </div> |  | ||||||
| </div> |  | ||||||
|  |  | ||||||
|  |  | ||||||
|            </div> |  | ||||||
|             |  | ||||||
|           </div> |  | ||||||
|           <footer> |  | ||||||
|     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |  | ||||||
|         <a href="cpl.application.html" class="btn btn-neutral float-right" title="cpl.application" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |  | ||||||
|         <a href="setup.html" class="btn btn-neutral float-left" title="Setting up the local environment and workspace" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |  | ||||||
|     </div> |  | ||||||
|  |  | ||||||
|   <hr/> |  | ||||||
|  |  | ||||||
|   <div role="contentinfo"> |  | ||||||
|     <p> |  | ||||||
|         © Copyright 2021, Sven Heidemann. |  | ||||||
|  |  | ||||||
|     </p> |  | ||||||
|   </div> |  | ||||||
|      |  | ||||||
|      |  | ||||||
|      |  | ||||||
|     Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |  | ||||||
|      |  | ||||||
|     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |  | ||||||
|      |  | ||||||
|     provided by <a href="https://readthedocs.org">Read the Docs</a>.  |  | ||||||
|  |  | ||||||
| </footer> |  | ||||||
|         </div> |  | ||||||
|       </div> |  | ||||||
|  |  | ||||||
|     </section> |  | ||||||
|  |  | ||||||
|   </div> |  | ||||||
|    |  | ||||||
|  |  | ||||||
|   <script type="text/javascript"> |  | ||||||
|       jQuery(function () { |  | ||||||
|           SphinxRtdTheme.Navigation.enable(true); |  | ||||||
|       }); |  | ||||||
|   </script> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|      |  | ||||||
|     |  | ||||||
|  |  | ||||||
| </body> |  | ||||||
| </html> |  | ||||||
							
								
								
									
										492
									
								
								docs/build/html/cpl.mailing.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										492
									
								
								docs/build/html/cpl.mailing.html
									
									
									
									
										vendored
									
									
								
							| @@ -1,492 +0,0 @@ | |||||||
|  |  | ||||||
|  |  | ||||||
| <!DOCTYPE html> |  | ||||||
| <html class="writer-html5" lang="en" > |  | ||||||
| <head> |  | ||||||
|   <meta charset="utf-8" /> |  | ||||||
|    |  | ||||||
|   <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |  | ||||||
|    |  | ||||||
|   <title>cpl.mailing — Common Python Library  documentation</title> |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |  | ||||||
|   <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <!--[if lt IE 9]> |  | ||||||
|     <script src="_static/js/html5shiv.min.js"></script> |  | ||||||
|   <![endif]--> |  | ||||||
|    |  | ||||||
|      |  | ||||||
|       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> |  | ||||||
|         <script src="_static/jquery.js"></script> |  | ||||||
|         <script src="_static/underscore.js"></script> |  | ||||||
|         <script src="_static/doctools.js"></script> |  | ||||||
|      |  | ||||||
|     <script type="text/javascript" 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.time" href="cpl.time.html" /> |  | ||||||
|     <link rel="prev" title="cpl.logging" href="cpl.logging.html" />  |  | ||||||
| </head> |  | ||||||
|  |  | ||||||
| <body class="wy-body-for-nav"> |  | ||||||
|  |  | ||||||
|     |  | ||||||
|   <div class="wy-grid-for-nav"> |  | ||||||
|      |  | ||||||
|     <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |  | ||||||
|       <div class="wy-side-scroll"> |  | ||||||
|         <div class="wy-side-nav-search" > |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
|             <a href="index.html" class="icon icon-home"> Common Python Library |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
|           </a> |  | ||||||
|  |  | ||||||
|            |  | ||||||
|              |  | ||||||
|              |  | ||||||
|            |  | ||||||
|  |  | ||||||
|            |  | ||||||
| <div role="search"> |  | ||||||
|   <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |  | ||||||
|     <input type="text" name="q" placeholder="Search docs" /> |  | ||||||
|     <input type="hidden" name="check_keywords" value="yes" /> |  | ||||||
|     <input type="hidden" name="area" value="default" /> |  | ||||||
|   </form> |  | ||||||
| </div> |  | ||||||
|  |  | ||||||
|            |  | ||||||
|         </div> |  | ||||||
|  |  | ||||||
|          |  | ||||||
|         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |  | ||||||
|            |  | ||||||
|              |  | ||||||
|              |  | ||||||
|                |  | ||||||
|              |  | ||||||
|              |  | ||||||
|               <ul class="current"> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current"> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.database.html">cpl.database</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.environment.html">cpl.environment</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.logging.html">cpl.logging</a></li> |  | ||||||
| <li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.mailing</a><ul> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.mailing.email">cpl.mailing.email</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.mailing.email_client_abc">cpl.mailing.email_client_abc</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.mailing.email_client_service">cpl.mailing.email_client_service</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.mailing.email_client_settings">cpl.mailing.email_client_settings</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.mailing.email_client_settings_name_enum">cpl.mailing.email_client_settings_name_enum</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li> |  | ||||||
| </ul> |  | ||||||
|  |  | ||||||
|              |  | ||||||
|            |  | ||||||
|         </div> |  | ||||||
|          |  | ||||||
|       </div> |  | ||||||
|     </nav> |  | ||||||
|  |  | ||||||
|     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |  | ||||||
|  |  | ||||||
|        |  | ||||||
|       <nav class="wy-nav-top" aria-label="top navigation"> |  | ||||||
|          |  | ||||||
|           <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |  | ||||||
|           <a href="index.html">Common Python Library</a> |  | ||||||
|          |  | ||||||
|       </nav> |  | ||||||
|  |  | ||||||
|  |  | ||||||
|       <div class="wy-nav-content"> |  | ||||||
|          |  | ||||||
|         <div class="rst-content"> |  | ||||||
|          |  | ||||||
|            |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
| <div role="navigation" aria-label="breadcrumbs navigation"> |  | ||||||
|  |  | ||||||
|   <ul class="wy-breadcrumbs"> |  | ||||||
|      |  | ||||||
|       <li><a href="index.html" class="icon icon-home"></a> »</li> |  | ||||||
|          |  | ||||||
|           <li><a href="cpl.html">API Reference</a> »</li> |  | ||||||
|          |  | ||||||
|       <li>cpl.mailing</li> |  | ||||||
|      |  | ||||||
|      |  | ||||||
|       <li class="wy-breadcrumbs-aside"> |  | ||||||
|          |  | ||||||
|            |  | ||||||
|             <a href="_sources/cpl.mailing.rst.txt" rel="nofollow"> View page source</a> |  | ||||||
|            |  | ||||||
|          |  | ||||||
|       </li> |  | ||||||
|      |  | ||||||
|   </ul> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|   <hr/> |  | ||||||
| </div> |  | ||||||
|           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |  | ||||||
|            <div itemprop="articleBody"> |  | ||||||
|              |  | ||||||
|   <div class="section" id="cpl-mailing"> |  | ||||||
| <h1>cpl.mailing<a class="headerlink" href="#cpl-mailing" title="Permalink to this headline">¶</a></h1> |  | ||||||
| <div class="section" id="module-cpl.mailing.email"> |  | ||||||
| <span id="cpl-mailing-email"></span><h2>cpl.mailing.email<a class="headerlink" href="#module-cpl.mailing.email" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.mailing.email.EMail"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.mailing.email.</span></code><code class="sig-name descname"><span class="pre">EMail</span></code><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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></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">subject</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></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">body</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></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">transceiver</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></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">receiver</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></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.mailing.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> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>header: list[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</dt><dd><p>Header of the E-Mail</p> |  | ||||||
| </dd> |  | ||||||
| <dt>subject: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Subject of the E-Mail</p> |  | ||||||
| </dd> |  | ||||||
| <dt>body: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Body of the E-Mail</p> |  | ||||||
| </dd> |  | ||||||
| <dt>transceiver: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Transceiver of the E-Mail</p> |  | ||||||
| </dd> |  | ||||||
| <dt>receiver: list[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</dt><dd><p>Receiver of the E-Mail</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.mailing.email.EMail.add_header"> |  | ||||||
| <code class="sig-name descname"><span class="pre">add_header</span></code><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="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email.EMail.add_header" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Adds header</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>header: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>The header of the E-Mail</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.mailing.email.EMail.add_receiver"> |  | ||||||
| <code class="sig-name descname"><span class="pre">add_receiver</span></code><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="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email.EMail.add_receiver" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Adds receiver</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>receiver: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>The receiver of the E-Mail</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.mailing.email.EMail.body"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">body</span></code><a class="headerlink" href="#cpl.mailing.email.EMail.body" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.mailing.email.EMail.check_mail"> |  | ||||||
| <em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">check_mail</span></code><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="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> → <span class="pre">bool</span><a class="headerlink" href="#cpl.mailing.email.EMail.check_mail" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Checks if an email is valid</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>address: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>The address to check</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| <blockquote> |  | ||||||
| <div><p>Result if E-Mail is valid or not</p> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.mailing.email.EMail.get_content"> |  | ||||||
| <code class="sig-name descname"><span class="pre">get_content</span></code><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="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email.EMail.get_content" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Returns the mail as string</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>transceiver: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>The transceiver of the E-Mail</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| <blockquote> |  | ||||||
| <div><p>E-Mail as string</p> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.mailing.email.EMail.header"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">header</span></code><a class="headerlink" href="#cpl.mailing.email.EMail.header" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.mailing.email.EMail.header_list"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">header_list</span></code><a class="headerlink" href="#cpl.mailing.email.EMail.header_list" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.mailing.email.EMail.receiver"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">receiver</span></code><a class="headerlink" href="#cpl.mailing.email.EMail.receiver" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.mailing.email.EMail.receiver_list"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">receiver_list</span></code><a class="headerlink" href="#cpl.mailing.email.EMail.receiver_list" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.mailing.email.EMail.subject"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">subject</span></code><a class="headerlink" href="#cpl.mailing.email.EMail.subject" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.mailing.email.EMail.transceiver"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">transceiver</span></code><a class="headerlink" href="#cpl.mailing.email.EMail.transceiver" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| <div class="section" id="module-cpl.mailing.email_client_abc"> |  | ||||||
| <span id="cpl-mailing-email-client-abc"></span><h2>cpl.mailing.email_client_abc<a class="headerlink" href="#module-cpl.mailing.email_client_abc" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.mailing.email_client_abc.EMailClientABC"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.mailing.email_client_abc.</span></code><code class="sig-name descname"><span class="pre">EMailClientABC</span></code><a class="headerlink" href="#cpl.mailing.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.ABC</span></code></p> |  | ||||||
| <p>ABC of <a class="reference internal" href="#cpl.mailing.email_client_service.EMailClient" title="cpl.mailing.email_client_service.EMailClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.mailing.email_client_service.EMailClient</span></code></a></p> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.mailing.email_client_abc.EMailClientABC.connect"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">connect</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.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 id="cpl.mailing.email_client_abc.EMailClientABC.send_mail"> |  | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">send_mail</span></code><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="n"><a class="reference internal" href="#cpl.mailing.email.EMail" title="cpl.mailing.email.EMail"><span class="pre">cpl.mailing.email.EMail</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email_client_abc.EMailClientABC.send_mail" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Sends email</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>email: <a class="reference internal" href="#cpl.mailing.email.EMail" title="cpl.mailing.email.EMail"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.mailing.email.EMail</span></code></a></dt><dd><p>Object of the E-Mail to send</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| <div class="section" id="module-cpl.mailing.email_client_service"> |  | ||||||
| <span id="cpl-mailing-email-client-service"></span><h2>cpl.mailing.email_client_service<a class="headerlink" href="#module-cpl.mailing.email_client_service" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.mailing.email_client_service.EMailClient"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.mailing.email_client_service.</span></code><code class="sig-name descname"><span class="pre">EMailClient</span></code><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="n"><a class="reference internal" href="cpl.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.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="n"><a class="reference internal" href="cpl.logging.html#cpl.logging.logger_abc.LoggerABC" title="cpl.logging.logger_abc.LoggerABC"><span class="pre">cpl.logging.logger_abc.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="n"><a class="reference internal" href="#cpl.mailing.email_client_settings.EMailClientSettings" title="cpl.mailing.email_client_settings.EMailClientSettings"><span class="pre">cpl.mailing.email_client_settings.EMailClientSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email_client_service.EMailClient" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Bases: <a class="reference internal" href="#cpl.mailing.email_client_abc.EMailClientABC" title="cpl.mailing.email_client_abc.EMailClientABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.mailing.email_client_abc.EMailClientABC</span></code></a></p> |  | ||||||
| <p>Service to send emails</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>environment: <a class="reference internal" href="cpl.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.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.logging.html#cpl.logging.logger_abc.LoggerABC" title="cpl.logging.logger_abc.LoggerABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.logging.logger_abc.LoggerABC</span></code></a></dt><dd><p>The logger to use</p> |  | ||||||
| </dd> |  | ||||||
| <dt>mail_settings: <a class="reference internal" href="#cpl.mailing.email_client_settings.EMailClientSettings" title="cpl.mailing.email_client_settings.EMailClientSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.mailing.email_client_settings.EMailClientSettings</span></code></a></dt><dd><p>Settings for mailing</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.mailing.email_client_service.EMailClient.connect"> |  | ||||||
| <code class="sig-name descname"><span class="pre">connect</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.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 id="cpl.mailing.email_client_service.EMailClient.create"> |  | ||||||
| <code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email_client_service.EMailClient.create" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Creates connection</p> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.mailing.email_client_service.EMailClient.login"> |  | ||||||
| <code class="sig-name descname"><span class="pre">login</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.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 id="cpl.mailing.email_client_service.EMailClient.send_mail"> |  | ||||||
| <code class="sig-name descname"><span class="pre">send_mail</span></code><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="n"><a class="reference internal" href="#cpl.mailing.email.EMail" title="cpl.mailing.email.EMail"><span class="pre">cpl.mailing.email.EMail</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email_client_service.EMailClient.send_mail" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Sends email</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><dl class="simple"> |  | ||||||
| <dt>email: <a class="reference internal" href="#cpl.mailing.email.EMail" title="cpl.mailing.email.EMail"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.mailing.email.EMail</span></code></a></dt><dd><p>Object of the E-Mail to send</p> |  | ||||||
| </dd> |  | ||||||
| </dl> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| <div class="section" id="module-cpl.mailing.email_client_settings"> |  | ||||||
| <span id="cpl-mailing-email-client-settings"></span><h2>cpl.mailing.email_client_settings<a class="headerlink" href="#module-cpl.mailing.email_client_settings" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.mailing.email_client_settings.EMailClientSettings"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.mailing.email_client_settings.</span></code><code class="sig-name descname"><span class="pre">EMailClientSettings</span></code><a class="headerlink" href="#cpl.mailing.email_client_settings.EMailClientSettings" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Bases: <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a></p> |  | ||||||
| <p>Representation of mailing settings</p> |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.mailing.email_client_settings.EMailClientSettings.credentials"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">credentials</span></code><a class="headerlink" href="#cpl.mailing.email_client_settings.EMailClientSettings.credentials" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.mailing.email_client_settings.EMailClientSettings.from_dict"> |  | ||||||
| <code class="sig-name descname"><span class="pre">from_dict</span></code><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="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email_client_settings.EMailClientSettings.from_dict" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd><p>Converts attributes to dict</p> |  | ||||||
| <blockquote> |  | ||||||
| <div><p>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p> |  | ||||||
| </div></blockquote> |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.mailing.email_client_settings.EMailClientSettings.host"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">host</span></code><a class="headerlink" href="#cpl.mailing.email_client_settings.EMailClientSettings.host" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.mailing.email_client_settings.EMailClientSettings.port"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">port</span></code><a class="headerlink" href="#cpl.mailing.email_client_settings.EMailClientSettings.port" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py method"> |  | ||||||
| <dt id="cpl.mailing.email_client_settings.EMailClientSettings.user_name"> |  | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">user_name</span></code><a class="headerlink" href="#cpl.mailing.email_client_settings.EMailClientSettings.user_name" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| <div class="section" id="module-cpl.mailing.email_client_settings_name_enum"> |  | ||||||
| <span id="cpl-mailing-email-client-settings-name-enum"></span><h2>cpl.mailing.email_client_settings_name_enum<a class="headerlink" href="#module-cpl.mailing.email_client_settings_name_enum" title="Permalink to this headline">¶</a></h2> |  | ||||||
| <dl class="py class"> |  | ||||||
| <dt id="cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum"> |  | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.mailing.email_client_settings_name_enum.</span></code><code class="sig-name descname"><span class="pre">EMailClientSettingsNameEnum</span></code><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.mailing.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.Enum</span></code></p> |  | ||||||
| <p>An enumeration.</p> |  | ||||||
| <dl class="py attribute"> |  | ||||||
| <dt id="cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.credentials"> |  | ||||||
| <code class="sig-name descname"><span class="pre">credentials</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Credentials'</span></em><a class="headerlink" href="#cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.credentials" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py attribute"> |  | ||||||
| <dt id="cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.host"> |  | ||||||
| <code class="sig-name descname"><span class="pre">host</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Host'</span></em><a class="headerlink" href="#cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.host" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py attribute"> |  | ||||||
| <dt id="cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.port"> |  | ||||||
| <code class="sig-name descname"><span class="pre">port</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Port'</span></em><a class="headerlink" href="#cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.port" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| <dl class="py attribute"> |  | ||||||
| <dt id="cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.user_name"> |  | ||||||
| <code class="sig-name descname"><span class="pre">user_name</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'UserName'</span></em><a class="headerlink" href="#cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.user_name" title="Permalink to this definition">¶</a></dt> |  | ||||||
| <dd></dd></dl> |  | ||||||
|  |  | ||||||
| </dd></dl> |  | ||||||
|  |  | ||||||
| </div> |  | ||||||
| </div> |  | ||||||
|  |  | ||||||
|  |  | ||||||
|            </div> |  | ||||||
|             |  | ||||||
|           </div> |  | ||||||
|           <footer> |  | ||||||
|     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |  | ||||||
|         <a href="cpl.time.html" class="btn btn-neutral float-right" title="cpl.time" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |  | ||||||
|         <a href="cpl.logging.html" class="btn btn-neutral float-left" title="cpl.logging" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |  | ||||||
|     </div> |  | ||||||
|  |  | ||||||
|   <hr/> |  | ||||||
|  |  | ||||||
|   <div role="contentinfo"> |  | ||||||
|     <p> |  | ||||||
|         © Copyright 2021, Sven Heidemann. |  | ||||||
|  |  | ||||||
|     </p> |  | ||||||
|   </div> |  | ||||||
|      |  | ||||||
|      |  | ||||||
|      |  | ||||||
|     Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |  | ||||||
|      |  | ||||||
|     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |  | ||||||
|      |  | ||||||
|     provided by <a href="https://readthedocs.org">Read the Docs</a>.  |  | ||||||
|  |  | ||||||
| </footer> |  | ||||||
|         </div> |  | ||||||
|       </div> |  | ||||||
|  |  | ||||||
|     </section> |  | ||||||
|  |  | ||||||
|   </div> |  | ||||||
|    |  | ||||||
|  |  | ||||||
|   <script type="text/javascript"> |  | ||||||
|       jQuery(function () { |  | ||||||
|           SphinxRtdTheme.Navigation.enable(true); |  | ||||||
|       }); |  | ||||||
|   </script> |  | ||||||
|  |  | ||||||
|    |  | ||||||
|    |  | ||||||
|      |  | ||||||
|     |  | ||||||
|  |  | ||||||
| </body> |  | ||||||
| </html> |  | ||||||
							
								
								
									
										7
									
								
								docs/build/html/cpl_cli.html
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										7
									
								
								docs/build/html/cpl_cli.html
									
									
									
									
										vendored
									
									
								
							| @@ -39,7 +39,7 @@ | |||||||
|     <link rel="index" title="Index" href="genindex.html" /> |     <link rel="index" title="Index" href="genindex.html" /> | ||||||
|     <link rel="search" title="Search" href="search.html" /> |     <link rel="search" title="Search" href="search.html" /> | ||||||
|     <link rel="next" title="CLI Overview and Command Reference" href="cli.overview.html" /> |     <link rel="next" title="CLI Overview and Command Reference" href="cli.overview.html" /> | ||||||
|     <link rel="prev" title="cpl.utils" href="cpl.utils.html" />  |     <link rel="prev" title="Setting up the local environment and workspace" href="setup.html" />  | ||||||
| </head> | </head> | ||||||
|  |  | ||||||
| <body class="wy-body-for-nav"> | <body class="wy-body-for-nav"> | ||||||
| @@ -87,7 +87,6 @@ | |||||||
|               <ul class="current"> |               <ul class="current"> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="cpl.html">API Reference</a></li> |  | ||||||
| <li class="toctree-l1 current"><a class="current reference internal" href="#">CLI Reference</a><ul> | <li class="toctree-l1 current"><a class="current reference internal" href="#">CLI Reference</a><ul> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li> | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li> | ||||||
| @@ -104,6 +103,8 @@ | |||||||
| <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | <li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li> | ||||||
| </ul> | </ul> | ||||||
| </li> | </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_query.html">Query Reference</a></li> | ||||||
| </ul> | </ul> | ||||||
|  |  | ||||||
|              |              | ||||||
| @@ -252,7 +253,7 @@ | |||||||
|           <footer> |           <footer> | ||||||
|     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||||||
|         <a href="cli.overview.html" class="btn btn-neutral float-right" title="CLI Overview and Command Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |         <a href="cli.overview.html" class="btn btn-neutral float-right" title="CLI Overview and Command Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> | ||||||
|         <a href="cpl.utils.html" class="btn btn-neutral float-left" title="cpl.utils" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |         <a href="setup.html" class="btn btn-neutral float-left" title="Setting up the local environment and workspace" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> | ||||||
|     </div> |     </div> | ||||||
|  |  | ||||||
|   <hr/> |   <hr/> | ||||||
|   | |||||||
							
								
								
									
										405
									
								
								docs/build/html/cpl_core.application.html
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										405
									
								
								docs/build/html/cpl_core.application.html
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,405 @@ | |||||||
|  |  | ||||||
|  |  | ||||||
|  | <!DOCTYPE html> | ||||||
|  | <html class="writer-html5" lang="en" > | ||||||
|  | <head> | ||||||
|  |   <meta charset="utf-8" /> | ||||||
|  |    | ||||||
|  |   <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||||||
|  |    | ||||||
|  |   <title>cpl_core.application — Common Python Library  documentation</title> | ||||||
|  |    | ||||||
|  |  | ||||||
|  |    | ||||||
|  |   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> | ||||||
|  |   <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | ||||||
|  |  | ||||||
|  |    | ||||||
|  |    | ||||||
|  |  | ||||||
|  |    | ||||||
|  |    | ||||||
|  |  | ||||||
|  |    | ||||||
|  |  | ||||||
|  |    | ||||||
|  |   <!--[if lt IE 9]> | ||||||
|  |     <script src="_static/js/html5shiv.min.js"></script> | ||||||
|  |   <![endif]--> | ||||||
|  |    | ||||||
|  |      | ||||||
|  |       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> | ||||||
|  |         <script src="_static/jquery.js"></script> | ||||||
|  |         <script src="_static/underscore.js"></script> | ||||||
|  |         <script src="_static/doctools.js"></script> | ||||||
|  |      | ||||||
|  |     <script type="text/javascript" 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" href="cpl_core.configuration.html" /> | ||||||
|  |     <link rel="prev" title="API Reference" href="cpl_core.html" />  | ||||||
|  | </head> | ||||||
|  |  | ||||||
|  | <body class="wy-body-for-nav"> | ||||||
|  |  | ||||||
|  |     | ||||||
|  |   <div class="wy-grid-for-nav"> | ||||||
|  |      | ||||||
|  |     <nav data-toggle="wy-nav-shift" class="wy-nav-side"> | ||||||
|  |       <div class="wy-side-scroll"> | ||||||
|  |         <div class="wy-side-nav-search" > | ||||||
|  |            | ||||||
|  |  | ||||||
|  |            | ||||||
|  |             <a href="index.html" class="icon icon-home"> Common Python Library | ||||||
|  |            | ||||||
|  |  | ||||||
|  |            | ||||||
|  |           </a> | ||||||
|  |  | ||||||
|  |            | ||||||
|  |              | ||||||
|  |              | ||||||
|  |            | ||||||
|  |  | ||||||
|  |            | ||||||
|  | <div role="search"> | ||||||
|  |   <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> | ||||||
|  |     <input type="text" name="q" placeholder="Search docs" /> | ||||||
|  |     <input type="hidden" name="check_keywords" value="yes" /> | ||||||
|  |     <input type="hidden" name="area" value="default" /> | ||||||
|  |   </form> | ||||||
|  | </div> | ||||||
|  |  | ||||||
|  |            | ||||||
|  |         </div> | ||||||
|  |  | ||||||
|  |          | ||||||
|  |         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> | ||||||
|  |            | ||||||
|  |              | ||||||
|  |              | ||||||
|  |                | ||||||
|  |              | ||||||
|  |              | ||||||
|  |               <ul class="current"> | ||||||
|  | <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | ||||||
|  | <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</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</a><ul> | ||||||
|  | <li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_abc">cpl_core.application.application_abc</a></li> | ||||||
|  | <li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_builder">cpl_core.application.application_builder</a></li> | ||||||
|  | <li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_builder_abc">cpl_core.application.application_builder_abc</a></li> | ||||||
|  | <li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.startup_abc">cpl_core.application.startup_abc</a></li> | ||||||
|  | </ul> | ||||||
|  | </li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html">cpl_core.database</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html">cpl_core.logging</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html">cpl_core.mailing</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li> | ||||||
|  | </ul> | ||||||
|  | </li> | ||||||
|  | <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> | ||||||
|  | </ul> | ||||||
|  |  | ||||||
|  |              | ||||||
|  |            | ||||||
|  |         </div> | ||||||
|  |          | ||||||
|  |       </div> | ||||||
|  |     </nav> | ||||||
|  |  | ||||||
|  |     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||||||
|  |  | ||||||
|  |        | ||||||
|  |       <nav class="wy-nav-top" aria-label="top navigation"> | ||||||
|  |          | ||||||
|  |           <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||||||
|  |           <a href="index.html">Common Python Library</a> | ||||||
|  |          | ||||||
|  |       </nav> | ||||||
|  |  | ||||||
|  |  | ||||||
|  |       <div class="wy-nav-content"> | ||||||
|  |          | ||||||
|  |         <div class="rst-content"> | ||||||
|  |          | ||||||
|  |            | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  |  | ||||||
|  | <div role="navigation" aria-label="breadcrumbs navigation"> | ||||||
|  |  | ||||||
|  |   <ul class="wy-breadcrumbs"> | ||||||
|  |      | ||||||
|  |       <li><a href="index.html" class="icon icon-home"></a> »</li> | ||||||
|  |          | ||||||
|  |           <li><a href="cpl_core.html">API Reference</a> »</li> | ||||||
|  |          | ||||||
|  |       <li>cpl_core.application</li> | ||||||
|  |      | ||||||
|  |      | ||||||
|  |       <li class="wy-breadcrumbs-aside"> | ||||||
|  |          | ||||||
|  |            | ||||||
|  |             <a href="_sources/cpl_core.application.rst.txt" rel="nofollow"> View page source</a> | ||||||
|  |            | ||||||
|  |          | ||||||
|  |       </li> | ||||||
|  |      | ||||||
|  |   </ul> | ||||||
|  |  | ||||||
|  |    | ||||||
|  |   <hr/> | ||||||
|  | </div> | ||||||
|  |           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> | ||||||
|  |            <div itemprop="articleBody"> | ||||||
|  |              | ||||||
|  |   <div class="section" id="cpl-core-application"> | ||||||
|  | <h1>cpl_core.application<a class="headerlink" href="#cpl-core-application" title="Permalink to this headline">¶</a></h1> | ||||||
|  | <div class="section" id="module-cpl_core.application.application_abc"> | ||||||
|  | <span id="cpl-core-application-application-abc"></span><h2>cpl_core.application.application_abc<a class="headerlink" href="#module-cpl_core.application.application_abc" title="Permalink to this headline">¶</a></h2> | ||||||
|  | <dl class="py class"> | ||||||
|  | <dt id="cpl_core.application.application_abc.ApplicationABC"> | ||||||
|  | <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.application.application_abc.</span></code><code class="sig-name descname"><span class="pre">ApplicationABC</span></code><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="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">cpl_core.configuration.configuration_abc.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="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">cpl_core.dependency_injection.service_provider_abc.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.ABC</span></code></p> | ||||||
|  | <p>ABC for the Application class</p> | ||||||
|  | <blockquote> | ||||||
|  | <div><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> | ||||||
|  | </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> | ||||||
|  | </dd> | ||||||
|  | </dl> | ||||||
|  | </div></blockquote> | ||||||
|  | <dl class="py method"> | ||||||
|  | <dt id="cpl_core.application.application_abc.ApplicationABC.configure"> | ||||||
|  | <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">configure</span></code><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> | ||||||
|  | </dd></dl> | ||||||
|  |  | ||||||
|  | <dl class="py method"> | ||||||
|  | <dt id="cpl_core.application.application_abc.ApplicationABC.main"> | ||||||
|  | <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">main</span></code><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> | ||||||
|  | </dd></dl> | ||||||
|  |  | ||||||
|  | <dl class="py method"> | ||||||
|  | <dt id="cpl_core.application.application_abc.ApplicationABC.run"> | ||||||
|  | <code class="sig-name descname"><span class="pre">run</span></code><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 id="cpl_core.application.application_abc.ApplicationABC.run_async"> | ||||||
|  | <em class="property"><span class="pre">async</span> </em><code class="sig-name descname"><span class="pre">run_async</span></code><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> | ||||||
|  |  | ||||||
|  | </dd></dl> | ||||||
|  |  | ||||||
|  | </div> | ||||||
|  | <div class="section" id="module-cpl_core.application.application_builder"> | ||||||
|  | <span id="cpl-core-application-application-builder"></span><h2>cpl_core.application.application_builder<a class="headerlink" href="#module-cpl_core.application.application_builder" title="Permalink to this headline">¶</a></h2> | ||||||
|  | <dl class="py class"> | ||||||
|  | <dt id="cpl_core.application.application_builder.ApplicationBuilder"> | ||||||
|  | <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.application.application_builder.</span></code><code class="sig-name descname"><span class="pre">ApplicationBuilder</span></code><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="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">cpl_core.application.application_abc.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">cpl_core.application.application_builder_abc.ApplicationBuilderABC</span></code></a></p> | ||||||
|  | <p>This is class is used to build a 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> | ||||||
|  | <blockquote> | ||||||
|  | <div><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> | ||||||
|  | </dd> | ||||||
|  | </dl> | ||||||
|  | </div></blockquote> | ||||||
|  | <dl class="py method"> | ||||||
|  | <dt id="cpl_core.application.application_builder.ApplicationBuilder.build"> | ||||||
|  | <code class="sig-name descname"><span class="pre">build</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a><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> | ||||||
|  | <blockquote> | ||||||
|  | <div><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> | ||||||
|  | </div></blockquote> | ||||||
|  | </dd></dl> | ||||||
|  |  | ||||||
|  | <dl class="py method"> | ||||||
|  | <dt id="cpl_core.application.application_builder.ApplicationBuilder.build_async"> | ||||||
|  | <em class="property"><span class="pre">async</span> </em><code class="sig-name descname"><span class="pre">build_async</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a><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> | ||||||
|  | <blockquote> | ||||||
|  | <div><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> | ||||||
|  | </div></blockquote> | ||||||
|  | </dd></dl> | ||||||
|  |  | ||||||
|  | <dl class="py method"> | ||||||
|  | <dt id="cpl_core.application.application_builder.ApplicationBuilder.use_extension"> | ||||||
|  | <code class="sig-name descname"><span class="pre">use_extension</span></code><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="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">cpl_core.application.application_extension_abc.ApplicationExtensionABC</span><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.use_extension" title="Permalink to this definition">¶</a></dt> | ||||||
|  | <dd></dd></dl> | ||||||
|  |  | ||||||
|  | <dl class="py method"> | ||||||
|  | <dt id="cpl_core.application.application_builder.ApplicationBuilder.use_startup"> | ||||||
|  | <code class="sig-name descname"><span class="pre">use_startup</span></code><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="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">cpl_core.application.startup_abc.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.ApplicationBuilder.use_startup" title="Permalink to this definition">¶</a></dt> | ||||||
|  | <dd><p>Sets the custom startup class to use async</p> | ||||||
|  | <blockquote> | ||||||
|  | <div><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> | ||||||
|  | </dd> | ||||||
|  | </dl> | ||||||
|  | </div></blockquote> | ||||||
|  | </dd></dl> | ||||||
|  |  | ||||||
|  | </dd></dl> | ||||||
|  |  | ||||||
|  | </div> | ||||||
|  | <div class="section" id="module-cpl_core.application.application_builder_abc"> | ||||||
|  | <span id="cpl-core-application-application-builder-abc"></span><h2>cpl_core.application.application_builder_abc<a class="headerlink" href="#module-cpl_core.application.application_builder_abc" title="Permalink to this headline">¶</a></h2> | ||||||
|  | <dl class="py class"> | ||||||
|  | <dt id="cpl_core.application.application_builder_abc.ApplicationBuilderABC"> | ||||||
|  | <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.application.application_builder_abc.</span></code><code class="sig-name descname"><span class="pre">ApplicationBuilderABC</span></code><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.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> | ||||||
|  | <dl class="py method"> | ||||||
|  | <dt id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.build"> | ||||||
|  | <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">build</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a><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> | ||||||
|  | <blockquote> | ||||||
|  | <div><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> | ||||||
|  | </div></blockquote> | ||||||
|  | </dd></dl> | ||||||
|  |  | ||||||
|  | <dl class="py method"> | ||||||
|  | <dt id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.build_async"> | ||||||
|  | <em class="property"><span class="pre">abstract</span> <span class="pre">async</span> </em><code class="sig-name descname"><span class="pre">build_async</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a><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> | ||||||
|  | <blockquote> | ||||||
|  | <div><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> | ||||||
|  | </div></blockquote> | ||||||
|  | </dd></dl> | ||||||
|  |  | ||||||
|  | <dl class="py method"> | ||||||
|  | <dt id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.use_startup"> | ||||||
|  | <em class="property"><span class="pre">abstract</span> <span class="pre">async</span> </em><code class="sig-name descname"><span class="pre">use_startup</span></code><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="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">cpl_core.application.startup_abc.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> | ||||||
|  | <blockquote> | ||||||
|  | <div><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> | ||||||
|  | </dd> | ||||||
|  | </dl> | ||||||
|  | </div></blockquote> | ||||||
|  | </dd></dl> | ||||||
|  |  | ||||||
|  | </dd></dl> | ||||||
|  |  | ||||||
|  | </div> | ||||||
|  | <div class="section" id="module-cpl_core.application.startup_abc"> | ||||||
|  | <span id="cpl-core-application-startup-abc"></span><h2>cpl_core.application.startup_abc<a class="headerlink" href="#module-cpl_core.application.startup_abc" title="Permalink to this headline">¶</a></h2> | ||||||
|  | <dl class="py class"> | ||||||
|  | <dt id="cpl_core.application.startup_abc.StartupABC"> | ||||||
|  | <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.application.startup_abc.</span></code><code class="sig-name descname"><span class="pre">StartupABC</span></code><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.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.ABC</span></code></p> | ||||||
|  | <p>ABC for the startup class</p> | ||||||
|  | <dl class="py method"> | ||||||
|  | <dt id="cpl_core.application.startup_abc.StartupABC.configure_configuration"> | ||||||
|  | <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">configure_configuration</span></code><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="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">cpl_core.configuration.configuration_abc.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="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">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span> → <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">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a><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> | ||||||
|  | <blockquote> | ||||||
|  | <div><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> | ||||||
|  | </div></blockquote> | ||||||
|  | <blockquote> | ||||||
|  | <div><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> | ||||||
|  | </div></blockquote> | ||||||
|  | </dd></dl> | ||||||
|  |  | ||||||
|  | <dl class="py method"> | ||||||
|  | <dt id="cpl_core.application.startup_abc.StartupABC.configure_services"> | ||||||
|  | <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">configure_services</span></code><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="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">cpl_core.dependency_injection.service_collection_abc.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="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">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span> → <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">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></a><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> | ||||||
|  | <blockquote> | ||||||
|  | <div><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> | ||||||
|  | </div></blockquote> | ||||||
|  | <blockquote> | ||||||
|  | <div><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> | ||||||
|  | </div></blockquote> | ||||||
|  | </dd></dl> | ||||||
|  |  | ||||||
|  | </dd></dl> | ||||||
|  |  | ||||||
|  | </div> | ||||||
|  | </div> | ||||||
|  |  | ||||||
|  |  | ||||||
|  |            </div> | ||||||
|  |             | ||||||
|  |           </div> | ||||||
|  |           <footer> | ||||||
|  |     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||||||
|  |         <a href="cpl_core.configuration.html" class="btn btn-neutral float-right" title="cpl_core.configuration" 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> | ||||||
|  |     </div> | ||||||
|  |  | ||||||
|  |   <hr/> | ||||||
|  |  | ||||||
|  |   <div role="contentinfo"> | ||||||
|  |     <p> | ||||||
|  |         © Copyright 2021, Sven Heidemann. | ||||||
|  |  | ||||||
|  |     </p> | ||||||
|  |   </div> | ||||||
|  |      | ||||||
|  |      | ||||||
|  |      | ||||||
|  |     Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a | ||||||
|  |      | ||||||
|  |     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> | ||||||
|  |      | ||||||
|  |     provided by <a href="https://readthedocs.org">Read the Docs</a>.  | ||||||
|  |  | ||||||
|  | </footer> | ||||||
|  |         </div> | ||||||
|  |       </div> | ||||||
|  |  | ||||||
|  |     </section> | ||||||
|  |  | ||||||
|  |   </div> | ||||||
|  |    | ||||||
|  |  | ||||||
|  |   <script type="text/javascript"> | ||||||
|  |       jQuery(function () { | ||||||
|  |           SphinxRtdTheme.Navigation.enable(true); | ||||||
|  |       }); | ||||||
|  |   </script> | ||||||
|  |  | ||||||
|  |    | ||||||
|  |    | ||||||
|  |      | ||||||
|  |     | ||||||
|  |  | ||||||
|  | </body> | ||||||
|  | </html> | ||||||
| @@ -7,7 +7,7 @@ | |||||||
|    |    | ||||||
|   <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |   <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||||||
|    |    | ||||||
|   <title>cpl.configuration — Common Python Library  documentation</title> |   <title>cpl_core.configuration — Common Python Library  documentation</title> | ||||||
|    |    | ||||||
| 
 | 
 | ||||||
|    |    | ||||||
| @@ -38,8 +38,8 @@ | |||||||
|      |      | ||||||
|     <link rel="index" title="Index" href="genindex.html" /> |     <link rel="index" title="Index" href="genindex.html" /> | ||||||
|     <link rel="search" title="Search" href="search.html" /> |     <link rel="search" title="Search" href="search.html" /> | ||||||
|     <link rel="next" title="cpl.console" href="cpl.console.html" /> |     <link rel="next" title="cpl_core.console" href="cpl_core.console.html" /> | ||||||
|     <link rel="prev" title="cpl.application" href="cpl.application.html" />  |     <link rel="prev" title="cpl_core.application" href="cpl_core.application.html" />  | ||||||
| </head> | </head> | ||||||
| 
 | 
 | ||||||
| <body class="wy-body-for-nav"> | <body class="wy-body-for-nav"> | ||||||
| @@ -87,27 +87,28 @@ | |||||||
|               <ul class="current"> |               <ul class="current"> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current"> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li> |  | ||||||
| <li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.configuration</a><ul> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.configuration.configuration">cpl.configuration.configuration</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.configuration.configuration_abc">cpl.configuration.configuration_abc</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.configuration.configuration_model_abc">cpl.configuration.configuration_model_abc</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.configuration.configuration_variable_name_enum">cpl.configuration.configuration_variable_name_enum</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.configuration.console_argument">cpl.configuration.console_argument</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.console.html">cpl.console</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.database.html">cpl.database</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.environment.html">cpl.environment</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.logging.html">cpl.logging</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li> |  | ||||||
| </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_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</a></li> | ||||||
|  | <li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.configuration</a><ul> | ||||||
|  | <li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration">cpl_core.configuration.configuration</a></li> | ||||||
|  | <li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration_abc">cpl_core.configuration.configuration_abc</a></li> | ||||||
|  | <li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration_model_abc">cpl_core.configuration.configuration_model_abc</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</a></li> | ||||||
|  | <li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.console_argument">cpl_core.configuration.console_argument</a></li> | ||||||
|  | </ul> | ||||||
|  | </li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html">cpl_core.database</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html">cpl_core.logging</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html">cpl_core.mailing</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li> | ||||||
|  | </ul> | ||||||
|  | </li> | ||||||
|  | <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> | ||||||
| </ul> | </ul> | ||||||
| 
 | 
 | ||||||
|              |              | ||||||
| @@ -156,15 +157,15 @@ | |||||||
|      |      | ||||||
|       <li><a href="index.html" class="icon icon-home"></a> »</li> |       <li><a href="index.html" class="icon icon-home"></a> »</li> | ||||||
|          |          | ||||||
|           <li><a href="cpl.html">API Reference</a> »</li> |           <li><a href="cpl_core.html">API Reference</a> »</li> | ||||||
|          |          | ||||||
|       <li>cpl.configuration</li> |       <li>cpl_core.configuration</li> | ||||||
|      |      | ||||||
|      |      | ||||||
|       <li class="wy-breadcrumbs-aside"> |       <li class="wy-breadcrumbs-aside"> | ||||||
|          |          | ||||||
|            |            | ||||||
|             <a href="_sources/cpl.configuration.rst.txt" rel="nofollow"> View page source</a> |             <a href="_sources/cpl_core.configuration.rst.txt" rel="nofollow"> View page source</a> | ||||||
|            |            | ||||||
|          |          | ||||||
|       </li> |       </li> | ||||||
| @@ -177,43 +178,43 @@ | |||||||
|           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> | ||||||
|            <div itemprop="articleBody"> |            <div itemprop="articleBody"> | ||||||
|              |              | ||||||
|   <div class="section" id="cpl-configuration"> |   <div class="section" id="cpl-core-configuration"> | ||||||
| <h1>cpl.configuration<a class="headerlink" href="#cpl-configuration" title="Permalink to this headline">¶</a></h1> | <h1>cpl_core.configuration<a class="headerlink" href="#cpl-core-configuration" title="Permalink to this headline">¶</a></h1> | ||||||
| <div class="section" id="module-cpl.configuration.configuration"> | <div class="section" id="module-cpl_core.configuration.configuration"> | ||||||
| <span id="cpl-configuration-configuration"></span><h2>cpl.configuration.configuration<a class="headerlink" href="#module-cpl.configuration.configuration" title="Permalink to this headline">¶</a></h2> | <span id="cpl-core-configuration-configuration"></span><h2>cpl_core.configuration.configuration<a class="headerlink" href="#module-cpl_core.configuration.configuration" title="Permalink to this headline">¶</a></h2> | ||||||
| <dl class="py class"> | <dl class="py class"> | ||||||
| <dt id="cpl.configuration.configuration.Configuration"> | <dt id="cpl_core.configuration.configuration.Configuration"> | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.configuration.configuration.</span></code><code class="sig-name descname"><span class="pre">Configuration</span></code><a class="headerlink" href="#cpl.configuration.configuration.Configuration" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration.</span></code><code class="sig-name descname"><span class="pre">Configuration</span></code><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.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></code></a></p> | <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">cpl_core.configuration.configuration_abc.ConfigurationABC</span></code></a></p> | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration.Configuration.add_configuration"> | <dt id="cpl_core.configuration.configuration.Configuration.add_configuration"> | ||||||
| <code class="sig-name descname"><span class="pre">add_configuration</span></code><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="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">type</span><span class="p"><span class="pre">]</span></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="n"><a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.configuration.configuration.Configuration.add_configuration" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">add_configuration</span></code><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="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">type</span><span class="p"><span class="pre">]</span></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="n"><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a></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> | <dd><p>Add configuration object</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| <dt>key_type: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>]</dt><dd><p>Type of the value</p> | <dt>key_type: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>]</dt><dd><p>Type of the value</p> | ||||||
| </dd> | </dd> | ||||||
| <dt>value: <a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a></dt><dd><p>Object of the value</p> | <dt>value: 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>]</dt><dd><p>Object of the value</p> | ||||||
| </dd> | </dd> | ||||||
| </dl> | </dl> | ||||||
| </div></blockquote> | </div></blockquote> | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration.Configuration.add_console_argument"> | <dt id="cpl_core.configuration.configuration.Configuration.add_console_argument"> | ||||||
| <code class="sig-name descname"><span class="pre">add_console_argument</span></code><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="n"><a class="reference internal" href="#cpl.configuration.console_argument.ConsoleArgument" title="cpl.configuration.console_argument.ConsoleArgument"><span class="pre">cpl.configuration.console_argument.ConsoleArgument</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.configuration.configuration.Configuration.add_console_argument" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">add_console_argument</span></code><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="n"><a class="reference internal" href="#cpl_core.configuration.console_argument.ConsoleArgument" title="cpl_core.configuration.console_argument.ConsoleArgument"><span class="pre">cpl_core.configuration.console_argument.ConsoleArgument</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> | <dd><p>Adds console argument to known console arguments</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| <dt>argument: <a class="reference internal" href="#cpl.configuration.console_argument.ConsoleArgument" title="cpl.configuration.console_argument.ConsoleArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.console_argument.ConsoleArgument</span></code></a></dt><dd><p>Specifies the console argument</p> | <dt>argument: <a class="reference internal" href="#cpl_core.configuration.console_argument.ConsoleArgument" title="cpl_core.configuration.console_argument.ConsoleArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.console_argument.ConsoleArgument</span></code></a></dt><dd><p>Specifies the console argument</p> | ||||||
| </dd> | </dd> | ||||||
| </dl> | </dl> | ||||||
| </div></blockquote> | </div></blockquote> | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration.Configuration.add_console_arguments"> | <dt id="cpl_core.configuration.configuration.Configuration.add_console_arguments"> | ||||||
| <code class="sig-name descname"><span class="pre">add_console_arguments</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></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.configuration.configuration.Configuration.add_console_arguments" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">add_console_arguments</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></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.configuration.configuration.Configuration.add_console_arguments" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Reads the console arguments</p> | <dd><p>Reads the console arguments</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| @@ -224,8 +225,8 @@ | |||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration.Configuration.add_environment_variables"> | <dt id="cpl_core.configuration.configuration.Configuration.add_environment_variables"> | ||||||
| <code class="sig-name descname"><span class="pre">add_environment_variables</span></code><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="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.configuration.configuration.Configuration.add_environment_variables" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">add_environment_variables</span></code><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="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> | <dd><p>Reads the environment variables</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| @@ -236,8 +237,8 @@ | |||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration.Configuration.add_json_file"> | <dt id="cpl_core.configuration.configuration.Configuration.add_json_file"> | ||||||
| <code class="sig-name descname"><span class="pre">add_json_file</span></code><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="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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></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">output</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></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.configuration.configuration.Configuration.add_json_file" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">add_json_file</span></code><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="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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></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">output</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></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.configuration.configuration.Configuration.add_json_file" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Reads and saves settings from given json file</p> | <dd><p>Reads and saves settings from given json file</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| @@ -254,73 +255,73 @@ | |||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration.Configuration.additional_arguments"> | <dt id="cpl_core.configuration.configuration.Configuration.additional_arguments"> | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">additional_arguments</span></code><a class="headerlink" href="#cpl.configuration.configuration.Configuration.additional_arguments" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">additional_arguments</span></code><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.additional_arguments" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration.Configuration.argument_error_function"> | <dt id="cpl_core.configuration.configuration.Configuration.argument_error_function"> | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">argument_error_function</span></code><a class="headerlink" href="#cpl.configuration.configuration.Configuration.argument_error_function" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">argument_error_function</span></code><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.argument_error_function" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration.Configuration.environment"> | <dt id="cpl_core.configuration.configuration.Configuration.environment"> | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">environment</span></code><a class="headerlink" href="#cpl.configuration.configuration.Configuration.environment" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">environment</span></code><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.environment" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration.Configuration.get_configuration"> | <dt id="cpl_core.configuration.configuration.Configuration.get_configuration"> | ||||||
| <code class="sig-name descname"><span class="pre">get_configuration</span></code><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="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</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.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> → <span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl.configuration.configuration.Configuration.get_configuration" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">get_configuration</span></code><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="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</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.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> → <span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</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> | <dd><p>Returns value from configuration by given type</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><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.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.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> | </dd> | ||||||
| </dl> | </dl> | ||||||
| </div></blockquote> | </div></blockquote> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><p>Object of Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, Callable[<a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a>]]</p> | <div><p>Object of Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, Callable[<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> | ||||||
| </div></blockquote> | </div></blockquote> | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| </div> | </div> | ||||||
| <div class="section" id="module-cpl.configuration.configuration_abc"> | <div class="section" id="module-cpl_core.configuration.configuration_abc"> | ||||||
| <span id="cpl-configuration-configuration-abc"></span><h2>cpl.configuration.configuration_abc<a class="headerlink" href="#module-cpl.configuration.configuration_abc" title="Permalink to this headline">¶</a></h2> | <span id="cpl-core-configuration-configuration-abc"></span><h2>cpl_core.configuration.configuration_abc<a class="headerlink" href="#module-cpl_core.configuration.configuration_abc" title="Permalink to this headline">¶</a></h2> | ||||||
| <dl class="py class"> | <dl class="py class"> | ||||||
| <dt id="cpl.configuration.configuration_abc.ConfigurationABC"> | <dt id="cpl_core.configuration.configuration_abc.ConfigurationABC"> | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.configuration.configuration_abc.</span></code><code class="sig-name descname"><span class="pre">ConfigurationABC</span></code><a class="headerlink" href="#cpl.configuration.configuration_abc.ConfigurationABC" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_abc.</span></code><code class="sig-name descname"><span class="pre">ConfigurationABC</span></code><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.ABC</span></code></p> | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p> | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration_abc.ConfigurationABC.add_configuration"> | <dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_configuration"> | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_configuration</span></code><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="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">type</span><span class="p"><span class="pre">]</span></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="n"><a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.configuration.configuration_abc.ConfigurationABC.add_configuration" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_configuration</span></code><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="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">type</span><span class="p"><span class="pre">]</span></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="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></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> | <dd><p>Add configuration object</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| <dt>key_type: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>]</dt><dd><p>Type of the value</p> | <dt>key_type: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>]</dt><dd><p>Type of the value</p> | ||||||
| </dd> | </dd> | ||||||
| <dt>value: <a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a></dt><dd><p>Object of the value</p> | <dt>value: 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>]</dt><dd><p>Object of the value</p> | ||||||
| </dd> | </dd> | ||||||
| </dl> | </dl> | ||||||
| </div></blockquote> | </div></blockquote> | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration_abc.ConfigurationABC.add_console_argument"> | <dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_argument"> | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_console_argument</span></code><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="n"><a class="reference internal" href="#cpl.configuration.console_argument.ConsoleArgument" title="cpl.configuration.console_argument.ConsoleArgument"><span class="pre">cpl.configuration.console_argument.ConsoleArgument</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.configuration.configuration_abc.ConfigurationABC.add_console_argument" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_console_argument</span></code><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="n"><a class="reference internal" href="#cpl_core.configuration.console_argument.ConsoleArgument" title="cpl_core.configuration.console_argument.ConsoleArgument"><span class="pre">cpl_core.configuration.console_argument.ConsoleArgument</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> | <dd><p>Adds console argument to known console arguments</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| <dt>argument: <a class="reference internal" href="#cpl.configuration.console_argument.ConsoleArgument" title="cpl.configuration.console_argument.ConsoleArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.console_argument.ConsoleArgument</span></code></a></dt><dd><p>Specifies the console argument</p> | <dt>argument: <a class="reference internal" href="#cpl_core.configuration.console_argument.ConsoleArgument" title="cpl_core.configuration.console_argument.ConsoleArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.console_argument.ConsoleArgument</span></code></a></dt><dd><p>Specifies the console argument</p> | ||||||
| </dd> | </dd> | ||||||
| </dl> | </dl> | ||||||
| </div></blockquote> | </div></blockquote> | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration_abc.ConfigurationABC.add_console_arguments"> | <dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_arguments"> | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_console_arguments</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></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.configuration.configuration_abc.ConfigurationABC.add_console_arguments" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_console_arguments</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></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.configuration.configuration_abc.ConfigurationABC.add_console_arguments" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Reads the console arguments</p> | <dd><p>Reads the console arguments</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| @@ -331,8 +332,8 @@ | |||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration_abc.ConfigurationABC.add_environment_variables"> | <dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_environment_variables"> | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_environment_variables</span></code><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="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.configuration.configuration_abc.ConfigurationABC.add_environment_variables" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_environment_variables</span></code><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="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> | <dd><p>Reads the environment variables</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| @@ -343,8 +344,8 @@ | |||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration_abc.ConfigurationABC.add_json_file"> | <dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file"> | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_json_file</span></code><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="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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></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">output</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></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.configuration.configuration_abc.ConfigurationABC.add_json_file" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_json_file</span></code><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="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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></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">output</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></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.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> | <dd><p>Reads and saves settings from given json file</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| @@ -361,47 +362,47 @@ | |||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration_abc.ConfigurationABC.additional_arguments"> | <dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.additional_arguments"> | ||||||
| <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">additional_arguments</span></code><a class="headerlink" href="#cpl.configuration.configuration_abc.ConfigurationABC.additional_arguments" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">additional_arguments</span></code><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.additional_arguments" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration_abc.ConfigurationABC.argument_error_function"> | <dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function"> | ||||||
| <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">argument_error_function</span></code><a class="headerlink" href="#cpl.configuration.configuration_abc.ConfigurationABC.argument_error_function" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">argument_error_function</span></code><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration_abc.ConfigurationABC.environment"> | <dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.environment"> | ||||||
| <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">environment</span></code><a class="headerlink" href="#cpl.configuration.configuration_abc.ConfigurationABC.environment" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">environment</span></code><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.environment" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration_abc.ConfigurationABC.get_configuration"> | <dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration"> | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">get_configuration</span></code><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="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</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.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> → <span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl.configuration.configuration_abc.ConfigurationABC.get_configuration" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">get_configuration</span></code><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="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</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.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> → <span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</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> | <dd><p>Returns value from configuration by given type</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><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.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.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> | </dd> | ||||||
| </dl> | </dl> | ||||||
| </div></blockquote> | </div></blockquote> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><p>Object of Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, Callable[<a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a>]]</p> | <div><p>Object of Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, Callable[<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> | ||||||
| </div></blockquote> | </div></blockquote> | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| </div> | </div> | ||||||
| <div class="section" id="module-cpl.configuration.configuration_model_abc"> | <div class="section" id="module-cpl_core.configuration.configuration_model_abc"> | ||||||
| <span id="cpl-configuration-configuration-model-abc"></span><h2>cpl.configuration.configuration_model_abc<a class="headerlink" href="#module-cpl.configuration.configuration_model_abc" title="Permalink to this headline">¶</a></h2> | <span id="cpl-core-configuration-configuration-model-abc"></span><h2>cpl_core.configuration.configuration_model_abc<a class="headerlink" href="#module-cpl_core.configuration.configuration_model_abc" title="Permalink to this headline">¶</a></h2> | ||||||
| <dl class="py class"> | <dl class="py class"> | ||||||
| <dt id="cpl.configuration.configuration_model_abc.ConfigurationModelABC"> | <dt id="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"> | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.configuration.configuration_model_abc.</span></code><code class="sig-name descname"><span class="pre">ConfigurationModelABC</span></code><a class="headerlink" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_model_abc.</span></code><code class="sig-name descname"><span class="pre">ConfigurationModelABC</span></code><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.ABC</span></code></p> | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p> | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration_model_abc.ConfigurationModelABC.from_dict"> | <dt id="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict"> | ||||||
| <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">from_dict</span></code><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="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC.from_dict" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">from_dict</span></code><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="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>Converts attributes to dict</p> | <dd><p>Converts attributes to dict</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><p>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p> | <div><p>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p> | ||||||
| @@ -411,70 +412,70 @@ | |||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| </div> | </div> | ||||||
| <div class="section" id="module-cpl.configuration.configuration_variable_name_enum"> | <div class="section" id="module-cpl_core.configuration.configuration_variable_name_enum"> | ||||||
| <span id="cpl-configuration-configuration-variable-name-enum"></span><h2>cpl.configuration.configuration_variable_name_enum<a class="headerlink" href="#module-cpl.configuration.configuration_variable_name_enum" title="Permalink to this headline">¶</a></h2> | <span id="cpl-core-configuration-configuration-variable-name-enum"></span><h2>cpl_core.configuration.configuration_variable_name_enum<a class="headerlink" href="#module-cpl_core.configuration.configuration_variable_name_enum" title="Permalink to this headline">¶</a></h2> | ||||||
| <dl class="py class"> | <dl class="py class"> | ||||||
| <dt id="cpl.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum"> | <dt id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum"> | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.configuration.configuration_variable_name_enum.</span></code><code class="sig-name descname"><span class="pre">ConfigurationVariableNameEnum</span></code><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.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_variable_name_enum.</span></code><code class="sig-name descname"><span class="pre">ConfigurationVariableNameEnum</span></code><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.Enum</span></code></p> | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p> | ||||||
| <p>An enumeration.</p> | <p>An enumeration.</p> | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.customer"> | <dt id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.customer"> | ||||||
| <code class="sig-name descname"><span class="pre">customer</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'CUSTOMER'</span></em><a class="headerlink" href="#cpl.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.customer" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">customer</span></code><em class="property"> <span class="pre">=</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> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.environment"> | <dt id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.environment"> | ||||||
| <code class="sig-name descname"><span class="pre">environment</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'ENVIRONMENT'</span></em><a class="headerlink" href="#cpl.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.environment" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">environment</span></code><em class="property"> <span class="pre">=</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> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.name"> | <dt id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.name"> | ||||||
| <code class="sig-name descname"><span class="pre">name</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'NAME'</span></em><a class="headerlink" href="#cpl.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.name" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">name</span></code><em class="property"> <span class="pre">=</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> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.to_list"> | <dt id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.to_list"> | ||||||
| <em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">to_list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.to_list" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">to_list</span></code><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></dd></dl> | ||||||
| 
 | 
 | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| </div> | </div> | ||||||
| <div class="section" id="module-cpl.configuration.console_argument"> | <div class="section" id="module-cpl_core.configuration.console_argument"> | ||||||
| <span id="cpl-configuration-console-argument"></span><h2>cpl.configuration.console_argument<a class="headerlink" href="#module-cpl.configuration.console_argument" title="Permalink to this headline">¶</a></h2> | <span id="cpl-core-configuration-console-argument"></span><h2>cpl_core.configuration.console_argument<a class="headerlink" href="#module-cpl_core.configuration.console_argument" title="Permalink to this headline">¶</a></h2> | ||||||
| <dl class="py class"> | <dl class="py class"> | ||||||
| <dt id="cpl.configuration.console_argument.ConsoleArgument"> | <dt id="cpl_core.configuration.console_argument.ConsoleArgument"> | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.configuration.console_argument.</span></code><code class="sig-name descname"><span class="pre">ConsoleArgument</span></code><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="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="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="n"><span class="pre">list</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="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_value_token_optional</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></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">console_arguments</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></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.configuration.console_argument.ConsoleArgument" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.configuration.console_argument.</span></code><code class="sig-name descname"><span class="pre">ConsoleArgument</span></code><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="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="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="n"><span class="pre">list</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="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_value_token_optional</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></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">console_arguments</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></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.configuration.console_argument.ConsoleArgument" 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> | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.console_argument.ConsoleArgument.aliases"> | <dt id="cpl_core.configuration.console_argument.ConsoleArgument.aliases"> | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">aliases</span></code><a class="headerlink" href="#cpl.configuration.console_argument.ConsoleArgument.aliases" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">aliases</span></code><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.aliases" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.console_argument.ConsoleArgument.console_arguments"> | <dt id="cpl_core.configuration.console_argument.ConsoleArgument.console_arguments"> | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">console_arguments</span></code><a class="headerlink" href="#cpl.configuration.console_argument.ConsoleArgument.console_arguments" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">console_arguments</span></code><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.console_arguments" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.console_argument.ConsoleArgument.is_value_token_optional"> | <dt id="cpl_core.configuration.console_argument.ConsoleArgument.is_value_token_optional"> | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">is_value_token_optional</span></code><a class="headerlink" href="#cpl.configuration.console_argument.ConsoleArgument.is_value_token_optional" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">is_value_token_optional</span></code><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.is_value_token_optional" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.console_argument.ConsoleArgument.name"> | <dt id="cpl_core.configuration.console_argument.ConsoleArgument.name"> | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">name</span></code><a class="headerlink" href="#cpl.configuration.console_argument.ConsoleArgument.name" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">name</span></code><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.name" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.console_argument.ConsoleArgument.token"> | <dt id="cpl_core.configuration.console_argument.ConsoleArgument.token"> | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">token</span></code><a class="headerlink" href="#cpl.configuration.console_argument.ConsoleArgument.token" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">token</span></code><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.token" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.configuration.console_argument.ConsoleArgument.value_token"> | <dt id="cpl_core.configuration.console_argument.ConsoleArgument.value_token"> | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">value_token</span></code><a class="headerlink" href="#cpl.configuration.console_argument.ConsoleArgument.value_token" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">value_token</span></code><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.value_token" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| </dd></dl> | </dd></dl> | ||||||
| @@ -488,8 +489,8 @@ | |||||||
|           </div> |           </div> | ||||||
|           <footer> |           <footer> | ||||||
|     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||||||
|         <a href="cpl.console.html" class="btn btn-neutral float-right" title="cpl.console" 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-right" title="cpl_core.console" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> | ||||||
|         <a href="cpl.application.html" class="btn btn-neutral float-left" title="cpl.application" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |         <a href="cpl_core.application.html" class="btn btn-neutral float-left" title="cpl_core.application" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> | ||||||
|     </div> |     </div> | ||||||
| 
 | 
 | ||||||
|   <hr/> |   <hr/> | ||||||
| @@ -7,7 +7,7 @@ | |||||||
|    |    | ||||||
|   <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |   <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||||||
|    |    | ||||||
|   <title>cpl.console — Common Python Library  documentation</title> |   <title>cpl_core.console — Common Python Library  documentation</title> | ||||||
|    |    | ||||||
| 
 | 
 | ||||||
|    |    | ||||||
| @@ -38,8 +38,8 @@ | |||||||
|      |      | ||||||
|     <link rel="index" title="Index" href="genindex.html" /> |     <link rel="index" title="Index" href="genindex.html" /> | ||||||
|     <link rel="search" title="Search" href="search.html" /> |     <link rel="search" title="Search" href="search.html" /> | ||||||
|     <link rel="next" title="cpl.database" href="cpl.database.html" /> |     <link rel="next" title="cpl_core.database" href="cpl_core.database.html" /> | ||||||
|     <link rel="prev" title="cpl.configuration" href="cpl.configuration.html" />  |     <link rel="prev" title="cpl_core.configuration" href="cpl_core.configuration.html" />  | ||||||
| </head> | </head> | ||||||
| 
 | 
 | ||||||
| <body class="wy-body-for-nav"> | <body class="wy-body-for-nav"> | ||||||
| @@ -87,27 +87,28 @@ | |||||||
|               <ul class="current"> |               <ul class="current"> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li> | ||||||
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li> | ||||||
| <li class="toctree-l1 current"><a class="reference internal" href="cpl.html">API Reference</a><ul class="current"> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.application.html">cpl.application</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.configuration.html">cpl.configuration</a></li> |  | ||||||
| <li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.console</a><ul> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.console.background_color_enum">cpl.console.background_color_enum</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.console.console">cpl.console.console</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.console.console_call">cpl.console.console_call</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.console.foreground_color_enum">cpl.console.foreground_color_enum</a></li> |  | ||||||
| <li class="toctree-l3"><a class="reference internal" href="#module-cpl.console.spinner_thread">cpl.console.spinner_thread</a></li> |  | ||||||
| </ul> |  | ||||||
| </li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.database.html">cpl.database</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.environment.html">cpl.environment</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.logging.html">cpl.logging</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li> |  | ||||||
| <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li> |  | ||||||
| </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_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</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li> | ||||||
|  | <li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.console</a><ul> | ||||||
|  | <li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.console.background_color_enum">cpl_core.console.background_color_enum</a></li> | ||||||
|  | <li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.console.console">cpl_core.console.console</a></li> | ||||||
|  | <li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.console.console_call">cpl_core.console.console_call</a></li> | ||||||
|  | <li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.console.foreground_color_enum">cpl_core.console.foreground_color_enum</a></li> | ||||||
|  | <li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.console.spinner_thread">cpl_core.console.spinner_thread</a></li> | ||||||
|  | </ul> | ||||||
|  | </li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html">cpl_core.database</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html">cpl_core.logging</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html">cpl_core.mailing</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time</a></li> | ||||||
|  | <li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li> | ||||||
|  | </ul> | ||||||
|  | </li> | ||||||
|  | <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li> | ||||||
| </ul> | </ul> | ||||||
| 
 | 
 | ||||||
|              |              | ||||||
| @@ -156,15 +157,15 @@ | |||||||
|      |      | ||||||
|       <li><a href="index.html" class="icon icon-home"></a> »</li> |       <li><a href="index.html" class="icon icon-home"></a> »</li> | ||||||
|          |          | ||||||
|           <li><a href="cpl.html">API Reference</a> »</li> |           <li><a href="cpl_core.html">API Reference</a> »</li> | ||||||
|          |          | ||||||
|       <li>cpl.console</li> |       <li>cpl_core.console</li> | ||||||
|      |      | ||||||
|      |      | ||||||
|       <li class="wy-breadcrumbs-aside"> |       <li class="wy-breadcrumbs-aside"> | ||||||
|          |          | ||||||
|            |            | ||||||
|             <a href="_sources/cpl.console.rst.txt" rel="nofollow"> View page source</a> |             <a href="_sources/cpl_core.console.rst.txt" rel="nofollow"> View page source</a> | ||||||
|            |            | ||||||
|          |          | ||||||
|       </li> |       </li> | ||||||
| @@ -177,78 +178,78 @@ | |||||||
|           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> | ||||||
|            <div itemprop="articleBody"> |            <div itemprop="articleBody"> | ||||||
|              |              | ||||||
|   <div class="section" id="cpl-console"> |   <div class="section" id="cpl-core-console"> | ||||||
| <h1>cpl.console<a class="headerlink" href="#cpl-console" title="Permalink to this headline">¶</a></h1> | <h1>cpl_core.console<a class="headerlink" href="#cpl-core-console" title="Permalink to this headline">¶</a></h1> | ||||||
| <div class="section" id="module-cpl.console.background_color_enum"> | <div class="section" id="module-cpl_core.console.background_color_enum"> | ||||||
| <span id="cpl-console-background-color-enum"></span><h2>cpl.console.background_color_enum<a class="headerlink" href="#module-cpl.console.background_color_enum" title="Permalink to this headline">¶</a></h2> | <span id="cpl-core-console-background-color-enum"></span><h2>cpl_core.console.background_color_enum<a class="headerlink" href="#module-cpl_core.console.background_color_enum" title="Permalink to this headline">¶</a></h2> | ||||||
| <dl class="py class"> | <dl class="py class"> | ||||||
| <dt id="cpl.console.background_color_enum.BackgroundColorEnum"> | <dt id="cpl_core.console.background_color_enum.BackgroundColorEnum"> | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.console.background_color_enum.</span></code><code class="sig-name descname"><span class="pre">BackgroundColorEnum</span></code><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.console.background_color_enum.BackgroundColorEnum" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.console.background_color_enum.</span></code><code class="sig-name descname"><span class="pre">BackgroundColorEnum</span></code><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.console.background_color_enum.BackgroundColorEnum" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p> | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p> | ||||||
| <p>An enumeration.</p> | <p>An enumeration.</p> | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.background_color_enum.BackgroundColorEnum.blue"> | <dt id="cpl_core.console.background_color_enum.BackgroundColorEnum.blue"> | ||||||
| <code class="sig-name descname"><span class="pre">blue</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_blue'</span></em><a class="headerlink" href="#cpl.console.background_color_enum.BackgroundColorEnum.blue" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">blue</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_blue'</span></em><a class="headerlink" href="#cpl_core.console.background_color_enum.BackgroundColorEnum.blue" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.background_color_enum.BackgroundColorEnum.cyan"> | <dt id="cpl_core.console.background_color_enum.BackgroundColorEnum.cyan"> | ||||||
| <code class="sig-name descname"><span class="pre">cyan</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_cyan'</span></em><a class="headerlink" href="#cpl.console.background_color_enum.BackgroundColorEnum.cyan" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">cyan</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_cyan'</span></em><a class="headerlink" href="#cpl_core.console.background_color_enum.BackgroundColorEnum.cyan" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.background_color_enum.BackgroundColorEnum.default"> | <dt id="cpl_core.console.background_color_enum.BackgroundColorEnum.default"> | ||||||
| <code class="sig-name descname"><span class="pre">default</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_default'</span></em><a class="headerlink" href="#cpl.console.background_color_enum.BackgroundColorEnum.default" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">default</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_default'</span></em><a class="headerlink" href="#cpl_core.console.background_color_enum.BackgroundColorEnum.default" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.background_color_enum.BackgroundColorEnum.green"> | <dt id="cpl_core.console.background_color_enum.BackgroundColorEnum.green"> | ||||||
| <code class="sig-name descname"><span class="pre">green</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_green'</span></em><a class="headerlink" href="#cpl.console.background_color_enum.BackgroundColorEnum.green" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">green</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_green'</span></em><a class="headerlink" href="#cpl_core.console.background_color_enum.BackgroundColorEnum.green" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.background_color_enum.BackgroundColorEnum.grey"> | <dt id="cpl_core.console.background_color_enum.BackgroundColorEnum.grey"> | ||||||
| <code class="sig-name descname"><span class="pre">grey</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_grey'</span></em><a class="headerlink" href="#cpl.console.background_color_enum.BackgroundColorEnum.grey" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">grey</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_grey'</span></em><a class="headerlink" href="#cpl_core.console.background_color_enum.BackgroundColorEnum.grey" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.background_color_enum.BackgroundColorEnum.magenta"> | <dt id="cpl_core.console.background_color_enum.BackgroundColorEnum.magenta"> | ||||||
| <code class="sig-name descname"><span class="pre">magenta</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_magenta'</span></em><a class="headerlink" href="#cpl.console.background_color_enum.BackgroundColorEnum.magenta" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">magenta</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_magenta'</span></em><a class="headerlink" href="#cpl_core.console.background_color_enum.BackgroundColorEnum.magenta" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.background_color_enum.BackgroundColorEnum.red"> | <dt id="cpl_core.console.background_color_enum.BackgroundColorEnum.red"> | ||||||
| <code class="sig-name descname"><span class="pre">red</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_red'</span></em><a class="headerlink" href="#cpl.console.background_color_enum.BackgroundColorEnum.red" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">red</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_red'</span></em><a class="headerlink" href="#cpl_core.console.background_color_enum.BackgroundColorEnum.red" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.background_color_enum.BackgroundColorEnum.white"> | <dt id="cpl_core.console.background_color_enum.BackgroundColorEnum.white"> | ||||||
| <code class="sig-name descname"><span class="pre">white</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_white'</span></em><a class="headerlink" href="#cpl.console.background_color_enum.BackgroundColorEnum.white" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">white</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_white'</span></em><a class="headerlink" href="#cpl_core.console.background_color_enum.BackgroundColorEnum.white" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.background_color_enum.BackgroundColorEnum.yellow"> | <dt id="cpl_core.console.background_color_enum.BackgroundColorEnum.yellow"> | ||||||
| <code class="sig-name descname"><span class="pre">yellow</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_yellow'</span></em><a class="headerlink" href="#cpl.console.background_color_enum.BackgroundColorEnum.yellow" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">yellow</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_yellow'</span></em><a class="headerlink" href="#cpl_core.console.background_color_enum.BackgroundColorEnum.yellow" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| </div> | </div> | ||||||
| <div class="section" id="module-cpl.console.console"> | <div class="section" id="module-cpl_core.console.console"> | ||||||
| <span id="cpl-console-console"></span><h2>cpl.console.console<a class="headerlink" href="#module-cpl.console.console" title="Permalink to this headline">¶</a></h2> | <span id="cpl-core-console-console"></span><h2>cpl_core.console.console<a class="headerlink" href="#module-cpl_core.console.console" title="Permalink to this headline">¶</a></h2> | ||||||
| <dl class="py class"> | <dl class="py class"> | ||||||
| <dt id="cpl.console.console.Console"> | <dt id="cpl_core.console.console.Console"> | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.console.console.</span></code><code class="sig-name descname"><span class="pre">Console</span></code><a class="headerlink" href="#cpl.console.console.Console" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.console.console.</span></code><code class="sig-name descname"><span class="pre">Console</span></code><a class="headerlink" href="#cpl_core.console.console.Console" 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> | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> | ||||||
| <p>Useful functions for handling with input and output</p> | <p>Useful functions for handling with input and output</p> | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.console.Console.background_color"> | <dt id="cpl_core.console.console.Console.background_color"> | ||||||
| <code class="sig-name descname"><span class="pre">background_color</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_default'</span></em><a class="headerlink" href="#cpl.console.console.Console.background_color" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">background_color</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'on_default'</span></em><a class="headerlink" href="#cpl_core.console.console.Console.background_color" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.banner"> | <dt id="cpl_core.console.console.Console.banner"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">banner</span></code><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="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.console.console.Console.banner" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">banner</span></code><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="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.banner" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Prints the string as a banner</p> | <dd><p>Prints the string as a banner</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| @@ -259,38 +260,38 @@ | |||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.clear"> | <dt id="cpl_core.console.console.Console.clear"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">clear</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.console.console.Console.clear" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">clear</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.clear" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Clears the console</p> | <dd><p>Clears the console</p> | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.close"> | <dt id="cpl_core.console.console.Console.close"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">close</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.console.console.Console.close" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">close</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.close" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Closes the application</p> | <dd><p>Closes the application</p> | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.color_reset"> | <dt id="cpl_core.console.console.Console.color_reset"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">color_reset</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.console.console.Console.color_reset" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">color_reset</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.color_reset" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Resets the color settings</p> | <dd><p>Resets the color settings</p> | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.disable"> | <dt id="cpl_core.console.console.Console.disable"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">disable</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.console.console.Console.disable" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">disable</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.disable" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Disables console interaction</p> | <dd><p>Disables console interaction</p> | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.enable"> | <dt id="cpl_core.console.console.Console.enable"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">enable</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.console.console.Console.enable" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">enable</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.enable" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Enables console interaction</p> | <dd><p>Enables console interaction</p> | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.error"> | <dt id="cpl_core.console.console.Console.error"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">error</span></code><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="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tb</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></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.console.console.Console.error" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">error</span></code><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="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tb</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></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.console.console.Console.error" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Prints an error with traceback</p> | <dd><p>Prints an error with traceback</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| @@ -303,13 +304,13 @@ | |||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.console.Console.foreground_color"> | <dt id="cpl_core.console.console.Console.foreground_color"> | ||||||
| <code class="sig-name descname"><span class="pre">foreground_color</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'default'</span></em><a class="headerlink" href="#cpl.console.console.Console.foreground_color" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">foreground_color</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'default'</span></em><a class="headerlink" href="#cpl_core.console.console.Console.foreground_color" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.read"> | <dt id="cpl_core.console.console.Console.read"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">read</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></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="pre">str</span><a class="headerlink" href="#cpl.console.console.Console.read" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">read</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></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="pre">str</span><a class="headerlink" href="#cpl_core.console.console.Console.read" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Reads in line</p> | <dd><p>Reads in line</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| @@ -323,8 +324,8 @@ | |||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.read_line"> | <dt id="cpl_core.console.console.Console.read_line"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">read_line</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></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="pre">str</span><a class="headerlink" href="#cpl.console.console.Console.read_line" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">read_line</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></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="pre">str</span><a class="headerlink" href="#cpl_core.console.console.Console.read_line" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Reads in next line</p> | <dd><p>Reads in next line</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| @@ -338,14 +339,14 @@ | |||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.reset_cursor_position"> | <dt id="cpl_core.console.console.Console.reset_cursor_position"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">reset_cursor_position</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.console.console.Console.reset_cursor_position" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">reset_cursor_position</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.reset_cursor_position" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Resets cursor position</p> | <dd><p>Resets cursor position</p> | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.select"> | <dt id="cpl_core.console.console.Console.select"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">select</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="pre">char:</span> <span class="pre">str</span></em>, <em class="sig-param"><span class="pre">message:</span> <span class="pre">str</span></em>, <em class="sig-param"><span class="pre">options:</span> <span class="pre">list</span></em>, <em class="sig-param"><span class="pre">header_foreground_color:</span> <span class="pre">Union[str</span></em>, <em class="sig-param"><span class="pre">cpl.console.foreground_color_enum.ForegroundColorEnum]</span> <span class="pre">=</span> <span class="pre"><ForegroundColorEnum.default:</span> <span class="pre">'default'></span></em>, <em class="sig-param"><span class="pre">header_background_color:</span> <span class="pre">Union[str</span></em>, <em class="sig-param"><span class="pre">cpl.console.background_color_enum.BackgroundColorEnum]</span> <span class="pre">=</span> <span class="pre"><BackgroundColorEnum.default:</span> <span class="pre">'on_default'></span></em>, <em class="sig-param"><span class="pre">option_foreground_color:</span> <span class="pre">Union[str</span></em>, <em class="sig-param"><span class="pre">cpl.console.foreground_color_enum.ForegroundColorEnum]</span> <span class="pre">=</span> <span class="pre"><ForegroundColorEnum.default:</span> <span class="pre">'default'></span></em>, <em class="sig-param"><span class="pre">option_background_color:</span> <span class="pre">Union[str</span></em>, <em class="sig-param"><span class="pre">cpl.console.background_color_enum.BackgroundColorEnum]</span> <span class="pre">=</span> <span class="pre"><BackgroundColorEnum.default:</span> <span class="pre">'on_default'></span></em>, <em class="sig-param"><span class="pre">cursor_foreground_color:</span> <span class="pre">Union[str</span></em>, <em class="sig-param"><span class="pre">cpl.console.foreground_color_enum.ForegroundColorEnum]</span> <span class="pre">=</span> <span class="pre"><ForegroundColorEnum.default:</span> <span class="pre">'default'></span></em>, <em class="sig-param"><span class="pre">cursor_background_color:</span> <span class="pre">Union[str</span></em>, <em class="sig-param"><span class="pre">cpl.console.background_color_enum.BackgroundColorEnum]</span> <span class="pre">=</span> <span class="pre"><BackgroundColorEnum.default:</span> <span class="pre">'on_default'></span></em><span class="sig-paren">)</span> → <span class="pre">str</span><a class="headerlink" href="#cpl.console.console.Console.select" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">select</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="pre">char:</span> <span class="pre">str</span></em>, <em class="sig-param"><span class="pre">message:</span> <span class="pre">str</span></em>, <em class="sig-param"><span class="pre">options:</span> <span class="pre">list</span></em>, <em class="sig-param"><span class="pre">header_foreground_color:</span> <span class="pre">Union[str</span></em>, <em class="sig-param"><span class="pre">cpl_core.console.foreground_color_enum.ForegroundColorEnum]</span> <span class="pre">=</span> <span class="pre"><ForegroundColorEnum.default:</span> <span class="pre">'default'></span></em>, <em class="sig-param"><span class="pre">header_background_color:</span> <span class="pre">Union[str</span></em>, <em class="sig-param"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum]</span> <span class="pre">=</span> <span class="pre"><BackgroundColorEnum.default:</span> <span class="pre">'on_default'></span></em>, <em class="sig-param"><span class="pre">option_foreground_color:</span> <span class="pre">Union[str</span></em>, <em class="sig-param"><span class="pre">cpl_core.console.foreground_color_enum.ForegroundColorEnum]</span> <span class="pre">=</span> <span class="pre"><ForegroundColorEnum.default:</span> <span class="pre">'default'></span></em>, <em class="sig-param"><span class="pre">option_background_color:</span> <span class="pre">Union[str</span></em>, <em class="sig-param"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum]</span> <span class="pre">=</span> <span class="pre"><BackgroundColorEnum.default:</span> <span class="pre">'on_default'></span></em>, <em class="sig-param"><span class="pre">cursor_foreground_color:</span> <span class="pre">Union[str</span></em>, <em class="sig-param"><span class="pre">cpl_core.console.foreground_color_enum.ForegroundColorEnum]</span> <span class="pre">=</span> <span class="pre"><ForegroundColorEnum.default:</span> <span class="pre">'default'></span></em>, <em class="sig-param"><span class="pre">cursor_background_color:</span> <span class="pre">Union[str</span></em>, <em class="sig-param"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum]</span> <span class="pre">=</span> <span class="pre"><BackgroundColorEnum.default:</span> <span class="pre">'on_default'></span></em><span class="sig-paren">)</span> → <span class="pre">str</span><a class="headerlink" href="#cpl_core.console.console.Console.select" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Prints select menu</p> | <dd><p>Prints select menu</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| @@ -355,17 +356,17 @@ | |||||||
| </dd> | </dd> | ||||||
| <dt>options: List[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</dt><dd><p>Selectable options</p> | <dt>options: List[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</dt><dd><p>Selectable options</p> | ||||||
| </dd> | </dd> | ||||||
| <dt>header_foreground_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl.console.foreground_color_enum.ForegroundColorEnum" title="cpl.console.foreground_color_enum.ForegroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.console.foreground_color_enum.ForegroundColorEnum</span></code></a>]</dt><dd><p>Foreground color of the header</p> | <dt>header_foreground_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.foreground_color_enum.ForegroundColorEnum</span></code></a>]</dt><dd><p>Foreground color of the header</p> | ||||||
| </dd> | </dd> | ||||||
| <dt>header_background_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl.console.background_color_enum.BackgroundColorEnum" title="cpl.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.console.background_color_enum.BackgroundColorEnum</span></code></a>]</dt><dd><p>Background color of the header</p> | <dt>header_background_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum</span></code></a>]</dt><dd><p>Background color of the header</p> | ||||||
| </dd> | </dd> | ||||||
| <dt>option_foreground_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl.console.foreground_color_enum.ForegroundColorEnum" title="cpl.console.foreground_color_enum.ForegroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.console.foreground_color_enum.ForegroundColorEnum</span></code></a>]</dt><dd><p>Foreground color of the options</p> | <dt>option_foreground_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.foreground_color_enum.ForegroundColorEnum</span></code></a>]</dt><dd><p>Foreground color of the options</p> | ||||||
| </dd> | </dd> | ||||||
| <dt>option_background_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl.console.background_color_enum.BackgroundColorEnum" title="cpl.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.console.background_color_enum.BackgroundColorEnum</span></code></a>]</dt><dd><p>Background color of the options</p> | <dt>option_background_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum</span></code></a>]</dt><dd><p>Background color of the options</p> | ||||||
| </dd> | </dd> | ||||||
| <dt>cursor_foreground_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl.console.foreground_color_enum.ForegroundColorEnum" title="cpl.console.foreground_color_enum.ForegroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.console.foreground_color_enum.ForegroundColorEnum</span></code></a>]</dt><dd><p>Foreground color of the cursor</p> | <dt>cursor_foreground_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.foreground_color_enum.ForegroundColorEnum</span></code></a>]</dt><dd><p>Foreground color of the cursor</p> | ||||||
| </dd> | </dd> | ||||||
| <dt>cursor_background_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl.console.background_color_enum.BackgroundColorEnum" title="cpl.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.console.background_color_enum.BackgroundColorEnum</span></code></a>]</dt><dd><p>Background color of the cursor</p> | <dt>cursor_background_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum</span></code></a>]</dt><dd><p>Background color of the cursor</p> | ||||||
| </dd> | </dd> | ||||||
| </dl> | </dl> | ||||||
| </div></blockquote> | </div></blockquote> | ||||||
| @@ -375,20 +376,20 @@ | |||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.set_background_color"> | <dt id="cpl_core.console.console.Console.set_background_color"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">set_background_color</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.console.background_color_enum.BackgroundColorEnum" title="cpl.console.background_color_enum.BackgroundColorEnum"><span class="pre">cpl.console.background_color_enum.BackgroundColorEnum</span></a><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.console.console.Console.set_background_color" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">set_background_color</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum</span></a><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.console.console.Console.set_background_color" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Sets the background color</p> | <dd><p>Sets the background color</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| <dt>color: Union[<a class="reference internal" href="#cpl.console.background_color_enum.BackgroundColorEnum" title="cpl.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.console.background_color_enum.BackgroundColorEnum</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</dt><dd><p>Background color of the console</p> | <dt>color: Union[<a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</dt><dd><p>Background color of the console</p> | ||||||
| </dd> | </dd> | ||||||
| </dl> | </dl> | ||||||
| </div></blockquote> | </div></blockquote> | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.set_cursor_position"> | <dt id="cpl_core.console.console.Console.set_cursor_position"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">set_cursor_position</span></code><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="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.console.console.Console.set_cursor_position" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">set_cursor_position</span></code><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="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.set_cursor_position" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Sets cursor position</p> | <dd><p>Sets cursor position</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| @@ -401,25 +402,25 @@ | |||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.set_foreground_color"> | <dt id="cpl_core.console.console.Console.set_foreground_color"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">set_foreground_color</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.console.foreground_color_enum.ForegroundColorEnum" title="cpl.console.foreground_color_enum.ForegroundColorEnum"><span class="pre">cpl.console.foreground_color_enum.ForegroundColorEnum</span></a><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.console.console.Console.set_foreground_color" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">set_foreground_color</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><span class="pre">cpl_core.console.foreground_color_enum.ForegroundColorEnum</span></a><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.console.console.Console.set_foreground_color" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Sets the foreground color</p> | <dd><p>Sets the foreground color</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| <dt>color: Union[<a class="reference internal" href="#cpl.console.background_color_enum.BackgroundColorEnum" title="cpl.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.console.background_color_enum.BackgroundColorEnum</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</dt><dd><p>Foreground color of the console</p> | <dt>color: Union[<a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</dt><dd><p>Foreground color of the console</p> | ||||||
| </dd> | </dd> | ||||||
| </dl> | </dl> | ||||||
| </div></blockquote> | </div></blockquote> | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.set_hold_back"> | <dt id="cpl_core.console.console.Console.set_hold_back"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">set_hold_back</span></code><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="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.console.console.Console.set_hold_back" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">set_hold_back</span></code><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="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.set_hold_back" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.spinner"> | <dt id="cpl_core.console.console.Console.spinner"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">spinner</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">call</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">collections.abc.Callable</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">text_foreground_color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><a class="reference internal" href="#cpl.console.foreground_color_enum.ForegroundColorEnum" title="cpl.console.foreground_color_enum.ForegroundColorEnum"><span class="pre">cpl.console.foreground_color_enum.ForegroundColorEnum</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></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">spinner_foreground_color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><a class="reference internal" href="#cpl.console.foreground_color_enum.ForegroundColorEnum" title="cpl.console.foreground_color_enum.ForegroundColorEnum"><span class="pre">cpl.console.foreground_color_enum.ForegroundColorEnum</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></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">text_background_color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><a class="reference internal" href="#cpl.console.background_color_enum.BackgroundColorEnum" title="cpl.console.background_color_enum.BackgroundColorEnum"><span class="pre">cpl.console.background_color_enum.BackgroundColorEnum</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></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">spinner_background_color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><a class="reference internal" href="#cpl.console.background_color_enum.BackgroundColorEnum" title="cpl.console.background_color_enum.BackgroundColorEnum"><span class="pre">cpl.console.background_color_enum.BackgroundColorEnum</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></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="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> → <span class="pre">any</span><a class="headerlink" href="#cpl.console.console.Console.spinner" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">spinner</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">call</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">collections.abc.Callable</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">text_foreground_color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><span class="pre">cpl_core.console.foreground_color_enum.ForegroundColorEnum</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></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">spinner_foreground_color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><span class="pre">cpl_core.console.foreground_color_enum.ForegroundColorEnum</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></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">text_background_color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></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">spinner_background_color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></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="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> → <span class="pre">any</span><a class="headerlink" href="#cpl_core.console.console.Console.spinner" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Shows spinner and calls given function, when function has ended the spinner stops</p> | <dd><p>Shows spinner and calls given function, when function has ended the spinner stops</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| @@ -429,13 +430,13 @@ | |||||||
| </dd> | </dd> | ||||||
| <dt>args: <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></dt><dd><p>Arguments of the function</p> | <dt>args: <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></dt><dd><p>Arguments of the function</p> | ||||||
| </dd> | </dd> | ||||||
| <dt>text_foreground_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl.console.foreground_color_enum.ForegroundColorEnum" title="cpl.console.foreground_color_enum.ForegroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.console.foreground_color_enum.ForegroundColorEnum</span></code></a>]</dt><dd><p>Foreground color of the text</p> | <dt>text_foreground_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.foreground_color_enum.ForegroundColorEnum</span></code></a>]</dt><dd><p>Foreground color of the text</p> | ||||||
| </dd> | </dd> | ||||||
| <dt>spinner_foreground_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl.console.foreground_color_enum.ForegroundColorEnum" title="cpl.console.foreground_color_enum.ForegroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.console.foreground_color_enum.ForegroundColorEnum</span></code></a>]</dt><dd><p>Foreground color of the spinner</p> | <dt>spinner_foreground_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.foreground_color_enum.ForegroundColorEnum</span></code></a>]</dt><dd><p>Foreground color of the spinner</p> | ||||||
| </dd> | </dd> | ||||||
| <dt>text_background_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl.console.background_color_enum.BackgroundColorEnum" title="cpl.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.console.background_color_enum.BackgroundColorEnum</span></code></a>]</dt><dd><p>Background color of the text</p> | <dt>text_background_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum</span></code></a>]</dt><dd><p>Background color of the text</p> | ||||||
| </dd> | </dd> | ||||||
| <dt>spinner_background_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl.console.background_color_enum.BackgroundColorEnum" title="cpl.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.console.background_color_enum.BackgroundColorEnum</span></code></a>]</dt><dd><p>Background color of the spinner</p> | <dt>spinner_background_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum</span></code></a>]</dt><dd><p>Background color of the spinner</p> | ||||||
| </dd> | </dd> | ||||||
| <dt>kwargs: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></dt><dd><p>Keyword arguments of the call</p> | <dt>kwargs: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></dt><dd><p>Keyword arguments of the call</p> | ||||||
| </dd> | </dd> | ||||||
| @@ -447,8 +448,8 @@ | |||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.table"> | <dt id="cpl_core.console.console.Console.table"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">table</span></code><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="n"><span class="pre">list</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="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.console.console.Console.table" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">table</span></code><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="n"><span class="pre">list</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="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.table" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Prints a table with header and values</p> | <dd><p>Prints a table with header and values</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| @@ -461,8 +462,8 @@ | |||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.write"> | <dt id="cpl_core.console.console.Console.write"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">write</span></code><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>, <em class="sig-param"><span class="n"><span class="pre">end</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.console.console.Console.write" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">write</span></code><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>, <em class="sig-param"><span class="n"><span class="pre">end</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.write" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Prints in active line</p> | <dd><p>Prints in active line</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| @@ -475,8 +476,8 @@ | |||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.write_at"> | <dt id="cpl_core.console.console.Console.write_at"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">write_at</span></code><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="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">int</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.console.console.Console.write_at" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">write_at</span></code><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="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">int</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.console.console.Console.write_at" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Prints at given position</p> | <dd><p>Prints at given position</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| @@ -491,8 +492,8 @@ | |||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.write_line"> | <dt id="cpl_core.console.console.Console.write_line"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">write_line</span></code><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.console.console.Console.write_line" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">write_line</span></code><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.console.console.Console.write_line" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Prints to new line</p> | <dd><p>Prints to new line</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| @@ -503,8 +504,8 @@ | |||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console.Console.write_line_at"> | <dt id="cpl_core.console.console.Console.write_line_at"> | ||||||
| <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">write_line_at</span></code><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="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">int</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.console.console.Console.write_line_at" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">classmethod</span> </em><code class="sig-name descname"><span class="pre">write_line_at</span></code><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="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">int</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.console.console.Console.write_line_at" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Prints new line at given position</p> | <dd><p>Prints new line at given position</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| @@ -521,11 +522,11 @@ | |||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| </div> | </div> | ||||||
| <div class="section" id="module-cpl.console.console_call"> | <div class="section" id="module-cpl_core.console.console_call"> | ||||||
| <span id="cpl-console-console-call"></span><h2>cpl.console.console_call<a class="headerlink" href="#module-cpl.console.console_call" title="Permalink to this headline">¶</a></h2> | <span id="cpl-core-console-console-call"></span><h2>cpl_core.console.console_call<a class="headerlink" href="#module-cpl_core.console.console_call" title="Permalink to this headline">¶</a></h2> | ||||||
| <dl class="py class"> | <dl class="py class"> | ||||||
| <dt id="cpl.console.console_call.ConsoleCall"> | <dt id="cpl_core.console.console_call.ConsoleCall"> | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.console.console_call.</span></code><code class="sig-name descname"><span class="pre">ConsoleCall</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">function</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">collections.abc.Callable</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.console.console_call.ConsoleCall" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.console.console_call.</span></code><code class="sig-name descname"><span class="pre">ConsoleCall</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">function</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">collections.abc.Callable</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.console.console_call.ConsoleCall" 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> | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> | ||||||
| <p>Represents a console call, for hold back when spinner is active</p> | <p>Represents a console call, for hold back when spinner is active</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| @@ -537,105 +538,105 @@ | |||||||
| </dl> | </dl> | ||||||
| </div></blockquote> | </div></blockquote> | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console_call.ConsoleCall.args"> | <dt id="cpl_core.console.console_call.ConsoleCall.args"> | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">args</span></code><a class="headerlink" href="#cpl.console.console_call.ConsoleCall.args" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">args</span></code><a class="headerlink" href="#cpl_core.console.console_call.ConsoleCall.args" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.console_call.ConsoleCall.function"> | <dt id="cpl_core.console.console_call.ConsoleCall.function"> | ||||||
| <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">function</span></code><a class="headerlink" href="#cpl.console.console_call.ConsoleCall.function" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">function</span></code><a class="headerlink" href="#cpl_core.console.console_call.ConsoleCall.function" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| </div> | </div> | ||||||
| <div class="section" id="module-cpl.console.foreground_color_enum"> | <div class="section" id="module-cpl_core.console.foreground_color_enum"> | ||||||
| <span id="cpl-console-foreground-color-enum"></span><h2>cpl.console.foreground_color_enum<a class="headerlink" href="#module-cpl.console.foreground_color_enum" title="Permalink to this headline">¶</a></h2> | <span id="cpl-core-console-foreground-color-enum"></span><h2>cpl_core.console.foreground_color_enum<a class="headerlink" href="#module-cpl_core.console.foreground_color_enum" title="Permalink to this headline">¶</a></h2> | ||||||
| <dl class="py class"> | <dl class="py class"> | ||||||
| <dt id="cpl.console.foreground_color_enum.ForegroundColorEnum"> | <dt id="cpl_core.console.foreground_color_enum.ForegroundColorEnum"> | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.console.foreground_color_enum.</span></code><code class="sig-name descname"><span class="pre">ForegroundColorEnum</span></code><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.console.foreground_color_enum.ForegroundColorEnum" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.console.foreground_color_enum.</span></code><code class="sig-name descname"><span class="pre">ForegroundColorEnum</span></code><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.console.foreground_color_enum.ForegroundColorEnum" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p> | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p> | ||||||
| <p>An enumeration.</p> | <p>An enumeration.</p> | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.foreground_color_enum.ForegroundColorEnum.blue"> | <dt id="cpl_core.console.foreground_color_enum.ForegroundColorEnum.blue"> | ||||||
| <code class="sig-name descname"><span class="pre">blue</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'blue'</span></em><a class="headerlink" href="#cpl.console.foreground_color_enum.ForegroundColorEnum.blue" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">blue</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'blue'</span></em><a class="headerlink" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum.blue" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.foreground_color_enum.ForegroundColorEnum.cyan"> | <dt id="cpl_core.console.foreground_color_enum.ForegroundColorEnum.cyan"> | ||||||
| <code class="sig-name descname"><span class="pre">cyan</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'cyan'</span></em><a class="headerlink" href="#cpl.console.foreground_color_enum.ForegroundColorEnum.cyan" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">cyan</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'cyan'</span></em><a class="headerlink" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum.cyan" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.foreground_color_enum.ForegroundColorEnum.default"> | <dt id="cpl_core.console.foreground_color_enum.ForegroundColorEnum.default"> | ||||||
| <code class="sig-name descname"><span class="pre">default</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'default'</span></em><a class="headerlink" href="#cpl.console.foreground_color_enum.ForegroundColorEnum.default" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">default</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'default'</span></em><a class="headerlink" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum.default" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.foreground_color_enum.ForegroundColorEnum.green"> | <dt id="cpl_core.console.foreground_color_enum.ForegroundColorEnum.green"> | ||||||
| <code class="sig-name descname"><span class="pre">green</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'green'</span></em><a class="headerlink" href="#cpl.console.foreground_color_enum.ForegroundColorEnum.green" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">green</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'green'</span></em><a class="headerlink" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum.green" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.foreground_color_enum.ForegroundColorEnum.grey"> | <dt id="cpl_core.console.foreground_color_enum.ForegroundColorEnum.grey"> | ||||||
| <code class="sig-name descname"><span class="pre">grey</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'grey'</span></em><a class="headerlink" href="#cpl.console.foreground_color_enum.ForegroundColorEnum.grey" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">grey</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'grey'</span></em><a class="headerlink" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum.grey" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.foreground_color_enum.ForegroundColorEnum.magenta"> | <dt id="cpl_core.console.foreground_color_enum.ForegroundColorEnum.magenta"> | ||||||
| <code class="sig-name descname"><span class="pre">magenta</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'magenta'</span></em><a class="headerlink" href="#cpl.console.foreground_color_enum.ForegroundColorEnum.magenta" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">magenta</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'magenta'</span></em><a class="headerlink" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum.magenta" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.foreground_color_enum.ForegroundColorEnum.red"> | <dt id="cpl_core.console.foreground_color_enum.ForegroundColorEnum.red"> | ||||||
| <code class="sig-name descname"><span class="pre">red</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'red'</span></em><a class="headerlink" href="#cpl.console.foreground_color_enum.ForegroundColorEnum.red" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">red</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'red'</span></em><a class="headerlink" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum.red" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.foreground_color_enum.ForegroundColorEnum.white"> | <dt id="cpl_core.console.foreground_color_enum.ForegroundColorEnum.white"> | ||||||
| <code class="sig-name descname"><span class="pre">white</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'white'</span></em><a class="headerlink" href="#cpl.console.foreground_color_enum.ForegroundColorEnum.white" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">white</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'white'</span></em><a class="headerlink" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum.white" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py attribute"> | <dl class="py attribute"> | ||||||
| <dt id="cpl.console.foreground_color_enum.ForegroundColorEnum.yellow"> | <dt id="cpl_core.console.foreground_color_enum.ForegroundColorEnum.yellow"> | ||||||
| <code class="sig-name descname"><span class="pre">yellow</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'yellow'</span></em><a class="headerlink" href="#cpl.console.foreground_color_enum.ForegroundColorEnum.yellow" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">yellow</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'yellow'</span></em><a class="headerlink" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum.yellow" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd></dd></dl> | <dd></dd></dl> | ||||||
| 
 | 
 | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| </div> | </div> | ||||||
| <div class="section" id="module-cpl.console.spinner_thread"> | <div class="section" id="module-cpl_core.console.spinner_thread"> | ||||||
| <span id="cpl-console-spinner-thread"></span><h2>cpl.console.spinner_thread<a class="headerlink" href="#module-cpl.console.spinner_thread" title="Permalink to this headline">¶</a></h2> | <span id="cpl-core-console-spinner-thread"></span><h2>cpl_core.console.spinner_thread<a class="headerlink" href="#module-cpl_core.console.spinner_thread" title="Permalink to this headline">¶</a></h2> | ||||||
| <dl class="py class"> | <dl class="py class"> | ||||||
| <dt id="cpl.console.spinner_thread.SpinnerThread"> | <dt id="cpl_core.console.spinner_thread.SpinnerThread"> | ||||||
| <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.console.spinner_thread.</span></code><code class="sig-name descname"><span class="pre">SpinnerThread</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg_len</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">foreground_color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl.console.foreground_color_enum.ForegroundColorEnum" title="cpl.console.foreground_color_enum.ForegroundColorEnum"><span class="pre">cpl.console.foreground_color_enum.ForegroundColorEnum</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">background_color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl.console.background_color_enum.BackgroundColorEnum" title="cpl.console.background_color_enum.BackgroundColorEnum"><span class="pre">cpl.console.background_color_enum.BackgroundColorEnum</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.console.spinner_thread.SpinnerThread" title="Permalink to this definition">¶</a></dt> | <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.console.spinner_thread.</span></code><code class="sig-name descname"><span class="pre">SpinnerThread</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg_len</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">foreground_color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><span class="pre">cpl_core.console.foreground_color_enum.ForegroundColorEnum</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">background_color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.spinner_thread.SpinnerThread" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">threading.Thread</span></code></p> | <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">threading.Thread</span></code></p> | ||||||
| <p>Thread to show spinner in terminal</p> | <p>Thread to show spinner in terminal</p> | ||||||
| <blockquote> | <blockquote> | ||||||
| <div><dl class="simple"> | <div><dl class="simple"> | ||||||
| <dt>msg_len: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>Length of the message</p> | <dt>msg_len: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>Length of the message</p> | ||||||
| </dd> | </dd> | ||||||
| <dt>foreground_color: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.console.foreground_color.ForegroundColorEnum</span></code></dt><dd><p>Foreground color of the spinner</p> | <dt>foreground_color: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.foreground_color.ForegroundColorEnum</span></code></dt><dd><p>Foreground color of the spinner</p> | ||||||
| </dd> | </dd> | ||||||
| <dt>background_color: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.console.background_color.BackgroundColorEnum</span></code></dt><dd><p>Background color of the spinner</p> | <dt>background_color: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.background_color.BackgroundColorEnum</span></code></dt><dd><p>Background color of the spinner</p> | ||||||
| </dd> | </dd> | ||||||
| </dl> | </dl> | ||||||
| </div></blockquote> | </div></blockquote> | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.spinner_thread.SpinnerThread.exit"> | <dt id="cpl_core.console.spinner_thread.SpinnerThread.exit"> | ||||||
| <code class="sig-name descname"><span class="pre">exit</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.console.spinner_thread.SpinnerThread.exit" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">exit</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.spinner_thread.SpinnerThread.exit" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Stops the spinner</p> | <dd><p>Stops the spinner</p> | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.spinner_thread.SpinnerThread.run"> | <dt id="cpl_core.console.spinner_thread.SpinnerThread.run"> | ||||||
| <code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <span class="pre">None</span><a class="headerlink" href="#cpl.console.spinner_thread.SpinnerThread.run" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <span class="pre">None</span><a class="headerlink" href="#cpl_core.console.spinner_thread.SpinnerThread.run" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Entry point of thread, shows the spinner</p> | <dd><p>Entry point of thread, shows the spinner</p> | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| <dl class="py method"> | <dl class="py method"> | ||||||
| <dt id="cpl.console.spinner_thread.SpinnerThread.stop_spinning"> | <dt id="cpl_core.console.spinner_thread.SpinnerThread.stop_spinning"> | ||||||
| <code class="sig-name descname"><span class="pre">stop_spinning</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.console.spinner_thread.SpinnerThread.stop_spinning" title="Permalink to this definition">¶</a></dt> | <code class="sig-name descname"><span class="pre">stop_spinning</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.spinner_thread.SpinnerThread.stop_spinning" title="Permalink to this definition">¶</a></dt> | ||||||
| <dd><p>Stops the spinner</p> | <dd><p>Stops the spinner</p> | ||||||
| </dd></dl> | </dd></dl> | ||||||
| 
 | 
 | ||||||
| @@ -650,8 +651,8 @@ | |||||||
|           </div> |           </div> | ||||||
|           <footer> |           <footer> | ||||||
|     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||||||
|         <a href="cpl.database.html" class="btn btn-neutral float-right" title="cpl.database" 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-right" title="cpl_core.database" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> | ||||||
|         <a href="cpl.configuration.html" class="btn btn-neutral float-left" title="cpl.configuration" 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-left" title="cpl_core.configuration" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> | ||||||
|     </div> |     </div> | ||||||
| 
 | 
 | ||||||
|   <hr/> |   <hr/> | ||||||
Some files were not shown because too many files have changed in this diff Show More
		Reference in New Issue
	
	Block a user