#154 #164
BIN
docs/build/doctrees/contributing.doctree
vendored
BIN
docs/build/doctrees/contributing.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.add.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.add.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.build.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.build.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.generate.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.generate.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.help.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.help.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.install.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.install.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.new.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.new.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.overview.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.overview.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.publish.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.publish.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.remove.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.remove.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.run.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.run.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.start.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.start.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.uninstall.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.uninstall.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.update.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.update.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.version.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.version.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.application.doctree
vendored
BIN
docs/build/doctrees/cpl_core.application.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.configuration.doctree
vendored
BIN
docs/build/doctrees/cpl_core.configuration.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.console.doctree
vendored
BIN
docs/build/doctrees/cpl_core.console.doctree
vendored
Binary file not shown.
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.database.doctree
vendored
BIN
docs/build/doctrees/cpl_core.database.doctree
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.doctree
vendored
BIN
docs/build/doctrees/cpl_core.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.environment.doctree
vendored
BIN
docs/build/doctrees/cpl_core.environment.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.logging.doctree
vendored
BIN
docs/build/doctrees/cpl_core.logging.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.mailing.doctree
vendored
BIN
docs/build/doctrees/cpl_core.mailing.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.pipes.doctree
vendored
BIN
docs/build/doctrees/cpl_core.pipes.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.time.doctree
vendored
BIN
docs/build/doctrees/cpl_core.time.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.utils.doctree
vendored
BIN
docs/build/doctrees/cpl_core.utils.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.application.doctree
vendored
BIN
docs/build/doctrees/cpl_discord.application.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.command.doctree
vendored
BIN
docs/build/doctrees/cpl_discord.command.doctree
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.container.doctree
vendored
BIN
docs/build/doctrees/cpl_discord.container.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.doctree
vendored
BIN
docs/build/doctrees/cpl_discord.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.events.doctree
vendored
BIN
docs/build/doctrees/cpl_discord.events.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.helper.doctree
vendored
BIN
docs/build/doctrees/cpl_discord.helper.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.service.doctree
vendored
BIN
docs/build/doctrees/cpl_discord.service.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.base.doctree
vendored
BIN
docs/build/doctrees/cpl_query.base.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.doctree
vendored
BIN
docs/build/doctrees/cpl_query.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.enumerable.doctree
vendored
BIN
docs/build/doctrees/cpl_query.enumerable.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.extension.doctree
vendored
BIN
docs/build/doctrees/cpl_query.extension.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.iterable.doctree
vendored
BIN
docs/build/doctrees/cpl_query.iterable.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_translation.doctree
vendored
BIN
docs/build/doctrees/cpl_translation.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/deprecated.doctree
vendored
Normal file
BIN
docs/build/doctrees/deprecated.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/getting_started.doctree
vendored
BIN
docs/build/doctrees/getting_started.doctree
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.
BIN
docs/build/doctrees/tutorials.appsettings.doctree
vendored
BIN
docs/build/doctrees/tutorials.appsettings.doctree
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/tutorials.console.doctree
vendored
BIN
docs/build/doctrees/tutorials.console.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tutorials.create-startup.doctree
vendored
BIN
docs/build/doctrees/tutorials.create-startup.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tutorials.doctree
vendored
BIN
docs/build/doctrees/tutorials.doctree
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/doctrees/tutorials.extend-startup.doctree
vendored
BIN
docs/build/doctrees/tutorials.extend-startup.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tutorials.logging.doctree
vendored
BIN
docs/build/doctrees/tutorials.logging.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tutorials.mail.doctree
vendored
BIN
docs/build/doctrees/tutorials.mail.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/tutorials.templating.doctree
vendored
BIN
docs/build/doctrees/tutorials.templating.doctree
vendored
Binary file not shown.
2
docs/build/html/.buildinfo
vendored
2
docs/build/html/.buildinfo
vendored
@ -1,4 +1,4 @@
|
||||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: 7051b788adc6d655ae340e56640c6925
|
||||
config: 7161cd79d6fb56140ef1c390e01dab1c
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
|
69
docs/build/html/_sources/deprecated.md.txt
vendored
Normal file
69
docs/build/html/_sources/deprecated.md.txt
vendored
Normal file
@ -0,0 +1,69 @@
|
||||
# Deprecated
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. [ConfigurationModelABC.from_dict](#ConfigurationModelABC-from_dict-method)
|
||||
|
||||
## ConfigurationModelABC from_dict method
|
||||
|
||||
We now process the configuration models directly in the configuration by recursive parameter parsing.
|
||||
|
||||
The JSONProcessor now goes through the JSON and the arguments of the __init__ and links the attributes by name from the
|
||||
JSON and the name of the keyword argument.
|
||||
Now, based on the type, either simply assigns the value. With a ``dict`` the processor is called recursively and so the
|
||||
JSON is processed further. This way nested ConfigurationModels can be processed.
|
||||
|
||||
For this the code must be adapted as follows:
|
||||
|
||||
From this:
|
||||
|
||||
```sh
|
||||
class VersionSettings(ConfigurationModelABC):
|
||||
|
||||
def __init__(self):
|
||||
ConfigurationModelABC.__init__(self)
|
||||
|
||||
self.major: Optional[str] = "0"
|
||||
self.minor: Optional[str] = "0"
|
||||
self.micro: Optional[str] = "0"
|
||||
|
||||
def from_dict(self, settings: dict):
|
||||
self.major = settings["Major"]
|
||||
self.minor = settings["Minor"]
|
||||
micro = settings["Micro"]
|
||||
if micro != '':
|
||||
self.micro = micro
|
||||
```
|
||||
|
||||
To this:
|
||||
|
||||
```sh
|
||||
class VersionSettings(ConfigurationModelABC):
|
||||
def __init__(self, major: str = None, minor: str = None, micro: str = None):
|
||||
ConfigurationModelABC.__init__(self)
|
||||
|
||||
self.major: Optional[str] = major
|
||||
self.minor: Optional[str] = minor
|
||||
self.micro: Optional[str] = micro if micro != "" else None
|
||||
```
|
||||
|
||||
This makes the [from_dict](#from_dict) function obsolete.
|
||||
|
||||
A few rules must be observed:
|
||||
|
||||
- Only simple types can be processed
|
||||
<br>
|
||||
Wrong: ```dict[str, str]```
|
||||
<br>
|
||||
Correct: ```dict```
|
||||
<br>
|
||||
<br>
|
||||
Incorrect: ```list[str]```
|
||||
<br>
|
||||
Correct: ```list```
|
||||
|
||||
- The arguments must be optional, i.e. created as kwargs
|
||||
<br>
|
||||
Incorrect: ```def __init__(self, x: int, y: int)```
|
||||
<br>
|
||||
Correct: ```def __init__(self, x: int = None, y: int = None)```
|
3
docs/build/html/_sources/index.rst.txt
vendored
3
docs/build/html/_sources/index.rst.txt
vendored
@ -14,7 +14,7 @@ This CPL docs help you learn, understand and use the package. From your first ap
|
||||
Features
|
||||
--------
|
||||
- cpl-core
|
||||
- Expandle
|
||||
- Expandable
|
||||
- Application base
|
||||
- Standardized application classes
|
||||
- Application object builder
|
||||
@ -87,6 +87,7 @@ These pages go into great detail about everything the Library can do.
|
||||
introduction
|
||||
getting_started
|
||||
contributing
|
||||
deprecated
|
||||
cpl_cli
|
||||
cpl_core
|
||||
cpl_discord
|
||||
|
@ -1,20 +1,9 @@
|
||||
/*
|
||||
* _sphinx_javascript_frameworks_compat.js
|
||||
* ~~~~~~~~~~
|
||||
*
|
||||
* Compatability shim for jQuery and underscores.js.
|
||||
*
|
||||
* WILL BE REMOVED IN Sphinx 6.0
|
||||
* xref RemovedInSphinx60Warning
|
||||
/* Compatability shim for jQuery and underscores.js.
|
||||
*
|
||||
* Copyright Sphinx contributors
|
||||
* Released under the two clause BSD licence
|
||||
*/
|
||||
|
||||
/**
|
||||
* select a different prefix for underscore
|
||||
*/
|
||||
$u = _.noConflict();
|
||||
|
||||
|
||||
/**
|
||||
* small helper function to urldecode strings
|
||||
*
|
||||
|
47
docs/build/html/_static/basic.css
vendored
47
docs/build/html/_static/basic.css
vendored
@ -4,7 +4,7 @@
|
||||
*
|
||||
* Sphinx stylesheet -- basic theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote {
|
||||
a.headerlink {
|
||||
visibility: hidden;
|
||||
}
|
||||
a.brackets:before,
|
||||
span.brackets > a:before{
|
||||
content: "[";
|
||||
}
|
||||
|
||||
a.brackets:after,
|
||||
span.brackets > a:after {
|
||||
content: "]";
|
||||
}
|
||||
|
||||
|
||||
h1:hover > a.headerlink,
|
||||
h2:hover > a.headerlink,
|
||||
@ -334,11 +324,17 @@ aside.sidebar {
|
||||
p.sidebar-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
nav.contents,
|
||||
aside.topic,
|
||||
div.admonition, div.topic, blockquote {
|
||||
clear: left;
|
||||
}
|
||||
|
||||
/* -- topics ---------------------------------------------------------------- */
|
||||
|
||||
nav.contents,
|
||||
aside.topic,
|
||||
div.topic {
|
||||
border: 1px solid #ccc;
|
||||
padding: 7px;
|
||||
@ -377,6 +373,8 @@ div.body p.centered {
|
||||
|
||||
div.sidebar > :last-child,
|
||||
aside.sidebar > :last-child,
|
||||
nav.contents > :last-child,
|
||||
aside.topic > :last-child,
|
||||
div.topic > :last-child,
|
||||
div.admonition > :last-child {
|
||||
margin-bottom: 0;
|
||||
@ -384,6 +382,8 @@ div.admonition > :last-child {
|
||||
|
||||
div.sidebar::after,
|
||||
aside.sidebar::after,
|
||||
nav.contents::after,
|
||||
aside.topic::after,
|
||||
div.topic::after,
|
||||
div.admonition::after,
|
||||
blockquote::after {
|
||||
@ -609,25 +609,6 @@ ul.simple p {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
/* Docutils 0.17 and older (footnotes & citations) */
|
||||
dl.footnote > dt,
|
||||
dl.citation > dt {
|
||||
float: left;
|
||||
margin-right: 0.5em;
|
||||
}
|
||||
|
||||
dl.footnote > dd,
|
||||
dl.citation > dd {
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
|
||||
dl.footnote > dd:after,
|
||||
dl.citation > dd:after {
|
||||
content: "";
|
||||
clear: both;
|
||||
}
|
||||
|
||||
/* Docutils 0.18+ (footnotes & citations) */
|
||||
aside.footnote > span,
|
||||
div.citation > span {
|
||||
float: left;
|
||||
@ -652,8 +633,6 @@ div.citation > p:last-of-type:after {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
/* Footnotes & citations ends */
|
||||
|
||||
dl.field-list {
|
||||
display: grid;
|
||||
grid-template-columns: fit-content(30%) auto;
|
||||
@ -666,10 +645,6 @@ dl.field-list > dt {
|
||||
padding-right: 5px;
|
||||
}
|
||||
|
||||
dl.field-list > dt:after {
|
||||
content: ":";
|
||||
}
|
||||
|
||||
dl.field-list > dd {
|
||||
padding-left: 0.5em;
|
||||
margin-top: 0em;
|
||||
|
2
docs/build/html/_static/css/badge_only.css
vendored
2
docs/build/html/_static/css/badge_only.css
vendored
@ -1 +1 @@
|
||||
.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
|
||||
.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
|
4
docs/build/html/_static/css/theme.css
vendored
4
docs/build/html/_static/css/theme.css
vendored
File diff suppressed because one or more lines are too long
132
docs/build/html/_static/doctools.js
vendored
132
docs/build/html/_static/doctools.js
vendored
@ -4,12 +4,19 @@
|
||||
*
|
||||
* Base JavaScript utilities for all Sphinx HTML documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([
|
||||
"TEXTAREA",
|
||||
"INPUT",
|
||||
"SELECT",
|
||||
"BUTTON",
|
||||
]);
|
||||
|
||||
const _ready = (callback) => {
|
||||
if (document.readyState !== "loading") {
|
||||
callback();
|
||||
@ -18,73 +25,11 @@ const _ready = (callback) => {
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* highlight a given string on a node by wrapping it in
|
||||
* span elements with the given class name.
|
||||
*/
|
||||
const _highlight = (node, addItems, text, className) => {
|
||||
if (node.nodeType === Node.TEXT_NODE) {
|
||||
const val = node.nodeValue;
|
||||
const parent = node.parentNode;
|
||||
const pos = val.toLowerCase().indexOf(text);
|
||||
if (
|
||||
pos >= 0 &&
|
||||
!parent.classList.contains(className) &&
|
||||
!parent.classList.contains("nohighlight")
|
||||
) {
|
||||
let span;
|
||||
|
||||
const closestNode = parent.closest("body, svg, foreignObject");
|
||||
const isInSVG = closestNode && closestNode.matches("svg");
|
||||
if (isInSVG) {
|
||||
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
|
||||
} else {
|
||||
span = document.createElement("span");
|
||||
span.classList.add(className);
|
||||
}
|
||||
|
||||
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
||||
parent.insertBefore(
|
||||
span,
|
||||
parent.insertBefore(
|
||||
document.createTextNode(val.substr(pos + text.length)),
|
||||
node.nextSibling
|
||||
)
|
||||
);
|
||||
node.nodeValue = val.substr(0, pos);
|
||||
|
||||
if (isInSVG) {
|
||||
const rect = document.createElementNS(
|
||||
"http://www.w3.org/2000/svg",
|
||||
"rect"
|
||||
);
|
||||
const bbox = parent.getBBox();
|
||||
rect.x.baseVal.value = bbox.x;
|
||||
rect.y.baseVal.value = bbox.y;
|
||||
rect.width.baseVal.value = bbox.width;
|
||||
rect.height.baseVal.value = bbox.height;
|
||||
rect.setAttribute("class", className);
|
||||
addItems.push({ parent: parent, target: rect });
|
||||
}
|
||||
}
|
||||
} else if (node.matches && !node.matches("button, select, textarea")) {
|
||||
node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
|
||||
}
|
||||
};
|
||||
const _highlightText = (thisNode, text, className) => {
|
||||
let addItems = [];
|
||||
_highlight(thisNode, addItems, text, className);
|
||||
addItems.forEach((obj) =>
|
||||
obj.parent.insertAdjacentElement("beforebegin", obj.target)
|
||||
);
|
||||
};
|
||||
|
||||
/**
|
||||
* Small JavaScript module for the documentation.
|
||||
*/
|
||||
const Documentation = {
|
||||
init: () => {
|
||||
Documentation.highlightSearchWords();
|
||||
Documentation.initDomainIndexTable();
|
||||
Documentation.initOnKeyListeners();
|
||||
},
|
||||
@ -126,51 +71,6 @@ const Documentation = {
|
||||
Documentation.LOCALE = catalog.locale;
|
||||
},
|
||||
|
||||
/**
|
||||
* highlight the search words provided in the url in the text
|
||||
*/
|
||||
highlightSearchWords: () => {
|
||||
const highlight =
|
||||
new URLSearchParams(window.location.search).get("highlight") || "";
|
||||
const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
|
||||
if (terms.length === 0) return; // nothing to do
|
||||
|
||||
// There should never be more than one element matching "div.body"
|
||||
const divBody = document.querySelectorAll("div.body");
|
||||
const body = divBody.length ? divBody[0] : document.querySelector("body");
|
||||
window.setTimeout(() => {
|
||||
terms.forEach((term) => _highlightText(body, term, "highlighted"));
|
||||
}, 10);
|
||||
|
||||
const searchBox = document.getElementById("searchbox");
|
||||
if (searchBox === null) return;
|
||||
searchBox.appendChild(
|
||||
document
|
||||
.createRange()
|
||||
.createContextualFragment(
|
||||
'<p class="highlight-link">' +
|
||||
'<a href="javascript:Documentation.hideSearchWords()">' +
|
||||
Documentation.gettext("Hide Search Matches") +
|
||||
"</a></p>"
|
||||
)
|
||||
);
|
||||
},
|
||||
|
||||
/**
|
||||
* helper function to hide the search marks again
|
||||
*/
|
||||
hideSearchWords: () => {
|
||||
document
|
||||
.querySelectorAll("#searchbox .highlight-link")
|
||||
.forEach((el) => el.remove());
|
||||
document
|
||||
.querySelectorAll("span.highlighted")
|
||||
.forEach((el) => el.classList.remove("highlighted"));
|
||||
const url = new URL(window.location);
|
||||
url.searchParams.delete("highlight");
|
||||
window.history.replaceState({}, "", url);
|
||||
},
|
||||
|
||||
/**
|
||||
* helper function to focus on search bar
|
||||
*/
|
||||
@ -210,15 +110,11 @@ const Documentation = {
|
||||
)
|
||||
return;
|
||||
|
||||
const blacklistedElements = new Set([
|
||||
"TEXTAREA",
|
||||
"INPUT",
|
||||
"SELECT",
|
||||
"BUTTON",
|
||||
]);
|
||||
document.addEventListener("keydown", (event) => {
|
||||
if (blacklistedElements.has(document.activeElement.tagName)) return; // bail for input elements
|
||||
if (event.altKey || event.ctrlKey || event.metaKey) return; // bail with special keys
|
||||
// bail for input elements
|
||||
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
|
||||
// bail with special keys
|
||||
if (event.altKey || event.ctrlKey || event.metaKey) return;
|
||||
|
||||
if (!event.shiftKey) {
|
||||
switch (event.key) {
|
||||
@ -240,10 +136,6 @@ const Documentation = {
|
||||
event.preventDefault();
|
||||
}
|
||||
break;
|
||||
case "Escape":
|
||||
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
|
||||
Documentation.hideSearchWords();
|
||||
event.preventDefault();
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -10,5 +10,5 @@ var DOCUMENTATION_OPTIONS = {
|
||||
SOURCELINK_SUFFIX: '.txt',
|
||||
NAVIGATION_WITH_KEYS: false,
|
||||
SHOW_SEARCH_SUMMARY: true,
|
||||
ENABLE_SEARCH_SHORTCUTS: false,
|
||||
ENABLE_SEARCH_SHORTCUTS: true,
|
||||
};
|
10881
docs/build/html/_static/jquery-3.6.0.js
vendored
10881
docs/build/html/_static/jquery-3.6.0.js
vendored
File diff suppressed because it is too large
Load Diff
2
docs/build/html/_static/language_data.js
vendored
2
docs/build/html/_static/language_data.js
vendored
@ -5,7 +5,7 @@
|
||||
* This script contains the language-specific data used by searchtools.js,
|
||||
* namely the list of stopwords, stemmer, scorer and splitter.
|
||||
*
|
||||
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
93
docs/build/html/_static/searchtools.js
vendored
93
docs/build/html/_static/searchtools.js
vendored
@ -4,7 +4,7 @@
|
||||
*
|
||||
* Sphinx JavaScript utilities for the full-text search.
|
||||
*
|
||||
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
@ -57,14 +57,14 @@ const _removeChildren = (element) => {
|
||||
const _escapeRegExp = (string) =>
|
||||
string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
|
||||
|
||||
const _displayItem = (item, highlightTerms, searchTerms) => {
|
||||
const _displayItem = (item, searchTerms) => {
|
||||
const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
|
||||
const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT;
|
||||
const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
|
||||
const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
|
||||
const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
|
||||
|
||||
const [docName, title, anchor, descr] = item;
|
||||
const [docName, title, anchor, descr, score, _filename] = item;
|
||||
|
||||
let listItem = document.createElement("li");
|
||||
let requestUrl;
|
||||
@ -82,13 +82,12 @@ const _displayItem = (item, highlightTerms, searchTerms) => {
|
||||
requestUrl = docUrlRoot + docName + docFileSuffix;
|
||||
linkUrl = docName + docLinkSuffix;
|
||||
}
|
||||
const params = new URLSearchParams();
|
||||
params.set("highlight", [...highlightTerms].join(" "));
|
||||
let linkEl = listItem.appendChild(document.createElement("a"));
|
||||
linkEl.href = linkUrl + "?" + params.toString() + anchor;
|
||||
linkEl.href = linkUrl + anchor;
|
||||
linkEl.dataset.score = score;
|
||||
linkEl.innerHTML = title;
|
||||
if (descr)
|
||||
listItem.appendChild(document.createElement("span")).innerText =
|
||||
listItem.appendChild(document.createElement("span")).innerHTML =
|
||||
" (" + descr + ")";
|
||||
else if (showSearchSummary)
|
||||
fetch(requestUrl)
|
||||
@ -96,7 +95,7 @@ const _displayItem = (item, highlightTerms, searchTerms) => {
|
||||
.then((data) => {
|
||||
if (data)
|
||||
listItem.appendChild(
|
||||
Search.makeSearchSummary(data, searchTerms, highlightTerms)
|
||||
Search.makeSearchSummary(data, searchTerms)
|
||||
);
|
||||
});
|
||||
Search.output.appendChild(listItem);
|
||||
@ -116,15 +115,14 @@ const _finishSearch = (resultCount) => {
|
||||
const _displayNextItem = (
|
||||
results,
|
||||
resultCount,
|
||||
highlightTerms,
|
||||
searchTerms
|
||||
) => {
|
||||
// results left, load the summary and display it
|
||||
// this is intended to be dynamic (don't sub resultsCount)
|
||||
if (results.length) {
|
||||
_displayItem(results.pop(), highlightTerms, searchTerms);
|
||||
_displayItem(results.pop(), searchTerms);
|
||||
setTimeout(
|
||||
() => _displayNextItem(results, resultCount, highlightTerms, searchTerms),
|
||||
() => _displayNextItem(results, resultCount, searchTerms),
|
||||
5
|
||||
);
|
||||
}
|
||||
@ -155,10 +153,8 @@ const Search = {
|
||||
_pulse_status: -1,
|
||||
|
||||
htmlToText: (htmlString) => {
|
||||
const htmlElement = document
|
||||
.createRange()
|
||||
.createContextualFragment(htmlString);
|
||||
_removeChildren(htmlElement.querySelectorAll(".headerlink"));
|
||||
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
|
||||
htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() });
|
||||
const docContent = htmlElement.querySelector('[role="main"]');
|
||||
if (docContent !== undefined) return docContent.textContent;
|
||||
console.warn(
|
||||
@ -239,6 +235,12 @@ const Search = {
|
||||
* execute search (requires search index to be loaded)
|
||||
*/
|
||||
query: (query) => {
|
||||
const filenames = Search._index.filenames;
|
||||
const docNames = Search._index.docnames;
|
||||
const titles = Search._index.titles;
|
||||
const allTitles = Search._index.alltitles;
|
||||
const indexEntries = Search._index.indexentries;
|
||||
|
||||
// stem the search terms and add them to the correct list
|
||||
const stemmer = new Stemmer();
|
||||
const searchTerms = new Set();
|
||||
@ -266,6 +268,10 @@ const Search = {
|
||||
}
|
||||
});
|
||||
|
||||
if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js
|
||||
localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" "))
|
||||
}
|
||||
|
||||
// console.debug("SEARCH: searching for:");
|
||||
// console.info("required: ", [...searchTerms]);
|
||||
// console.info("excluded: ", [...excludedTerms]);
|
||||
@ -274,6 +280,40 @@ const Search = {
|
||||
let results = [];
|
||||
_removeChildren(document.getElementById("search-progress"));
|
||||
|
||||
const queryLower = query.toLowerCase();
|
||||
for (const [title, foundTitles] of Object.entries(allTitles)) {
|
||||
if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) {
|
||||
for (const [file, id] of foundTitles) {
|
||||
let score = Math.round(100 * queryLower.length / title.length)
|
||||
results.push([
|
||||
docNames[file],
|
||||
titles[file] !== title ? `${titles[file]} > ${title}` : title,
|
||||
id !== null ? "#" + id : "",
|
||||
null,
|
||||
score,
|
||||
filenames[file],
|
||||
]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// search for explicit entries in index directives
|
||||
for (const [entry, foundEntries] of Object.entries(indexEntries)) {
|
||||
if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
|
||||
for (const [file, id] of foundEntries) {
|
||||
let score = Math.round(100 * queryLower.length / entry.length)
|
||||
results.push([
|
||||
docNames[file],
|
||||
titles[file],
|
||||
id ? "#" + id : "",
|
||||
null,
|
||||
score,
|
||||
filenames[file],
|
||||
]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// lookup as object
|
||||
objectTerms.forEach((term) =>
|
||||
results.push(...Search.performObjectSearch(term, objectTerms))
|
||||
@ -320,7 +360,7 @@ const Search = {
|
||||
// console.info("search results:", Search.lastresults);
|
||||
|
||||
// print the results
|
||||
_displayNextItem(results, results.length, highlightTerms, searchTerms);
|
||||
_displayNextItem(results, results.length, searchTerms);
|
||||
},
|
||||
|
||||
/**
|
||||
@ -401,8 +441,8 @@ const Search = {
|
||||
// prepare search
|
||||
const terms = Search._index.terms;
|
||||
const titleTerms = Search._index.titleterms;
|
||||
const docNames = Search._index.docnames;
|
||||
const filenames = Search._index.filenames;
|
||||
const docNames = Search._index.docnames;
|
||||
const titles = Search._index.titles;
|
||||
|
||||
const scoreMap = new Map();
|
||||
@ -499,16 +539,15 @@ const Search = {
|
||||
/**
|
||||
* helper function to return a node containing the
|
||||
* search summary for a given text. keywords is a list
|
||||
* of stemmed words, highlightWords is the list of normal, unstemmed
|
||||
* words. the first one is used to find the occurrence, the
|
||||
* latter for highlighting it.
|
||||
* of stemmed words.
|
||||
*/
|
||||
makeSearchSummary: (htmlText, keywords, highlightWords) => {
|
||||
const text = Search.htmlToText(htmlText).toLowerCase();
|
||||
makeSearchSummary: (htmlText, keywords) => {
|
||||
const text = Search.htmlToText(htmlText);
|
||||
if (text === "") return null;
|
||||
|
||||
const textLower = text.toLowerCase();
|
||||
const actualStartPosition = [...keywords]
|
||||
.map((k) => text.indexOf(k.toLowerCase()))
|
||||
.map((k) => textLower.indexOf(k.toLowerCase()))
|
||||
.filter((i) => i > -1)
|
||||
.slice(-1)[0];
|
||||
const startWithContext = Math.max(actualStartPosition - 120, 0);
|
||||
@ -516,13 +555,9 @@ const Search = {
|
||||
const top = startWithContext === 0 ? "" : "...";
|
||||
const tail = startWithContext + 240 < text.length ? "..." : "";
|
||||
|
||||
let summary = document.createElement("div");
|
||||
let summary = document.createElement("p");
|
||||
summary.classList.add("context");
|
||||
summary.innerText = top + text.substr(startWithContext, 240).trim() + tail;
|
||||
|
||||
highlightWords.forEach((highlightWord) =>
|
||||
_highlightText(summary, highlightWord, "highlighted")
|
||||
);
|
||||
summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
|
||||
|
||||
return summary;
|
||||
},
|
||||
|
144
docs/build/html/_static/sphinx_highlight.js
vendored
Normal file
144
docs/build/html/_static/sphinx_highlight.js
vendored
Normal file
@ -0,0 +1,144 @@
|
||||
/* Highlighting utilities for Sphinx HTML documentation. */
|
||||
"use strict";
|
||||
|
||||
const SPHINX_HIGHLIGHT_ENABLED = true
|
||||
|
||||
/**
|
||||
* highlight a given string on a node by wrapping it in
|
||||
* span elements with the given class name.
|
||||
*/
|
||||
const _highlight = (node, addItems, text, className) => {
|
||||
if (node.nodeType === Node.TEXT_NODE) {
|
||||
const val = node.nodeValue;
|
||||
const parent = node.parentNode;
|
||||
const pos = val.toLowerCase().indexOf(text);
|
||||
if (
|
||||
pos >= 0 &&
|
||||
!parent.classList.contains(className) &&
|
||||
!parent.classList.contains("nohighlight")
|
||||
) {
|
||||
let span;
|
||||
|
||||
const closestNode = parent.closest("body, svg, foreignObject");
|
||||
const isInSVG = closestNode && closestNode.matches("svg");
|
||||
if (isInSVG) {
|
||||
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
|
||||
} else {
|
||||
span = document.createElement("span");
|
||||
span.classList.add(className);
|
||||
}
|
||||
|
||||
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
||||
parent.insertBefore(
|
||||
span,
|
||||
parent.insertBefore(
|
||||
document.createTextNode(val.substr(pos + text.length)),
|
||||
node.nextSibling
|
||||
)
|
||||
);
|
||||
node.nodeValue = val.substr(0, pos);
|
||||
|
||||
if (isInSVG) {
|
||||
const rect = document.createElementNS(
|
||||
"http://www.w3.org/2000/svg",
|
||||
"rect"
|
||||
);
|
||||
const bbox = parent.getBBox();
|
||||
rect.x.baseVal.value = bbox.x;
|
||||
rect.y.baseVal.value = bbox.y;
|
||||
rect.width.baseVal.value = bbox.width;
|
||||
rect.height.baseVal.value = bbox.height;
|
||||
rect.setAttribute("class", className);
|
||||
addItems.push({ parent: parent, target: rect });
|
||||
}
|
||||
}
|
||||
} else if (node.matches && !node.matches("button, select, textarea")) {
|
||||
node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
|
||||
}
|
||||
};
|
||||
const _highlightText = (thisNode, text, className) => {
|
||||
let addItems = [];
|
||||
_highlight(thisNode, addItems, text, className);
|
||||
addItems.forEach((obj) =>
|
||||
obj.parent.insertAdjacentElement("beforebegin", obj.target)
|
||||
);
|
||||
};
|
||||
|
||||
/**
|
||||
* Small JavaScript module for the documentation.
|
||||
*/
|
||||
const SphinxHighlight = {
|
||||
|
||||
/**
|
||||
* highlight the search words provided in localstorage in the text
|
||||
*/
|
||||
highlightSearchWords: () => {
|
||||
if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight
|
||||
|
||||
// get and clear terms from localstorage
|
||||
const url = new URL(window.location);
|
||||
const highlight =
|
||||
localStorage.getItem("sphinx_highlight_terms")
|
||||
|| url.searchParams.get("highlight")
|
||||
|| "";
|
||||
localStorage.removeItem("sphinx_highlight_terms")
|
||||
url.searchParams.delete("highlight");
|
||||
window.history.replaceState({}, "", url);
|
||||
|
||||
// get individual terms from highlight string
|
||||
const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
|
||||
if (terms.length === 0) return; // nothing to do
|
||||
|
||||
// There should never be more than one element matching "div.body"
|
||||
const divBody = document.querySelectorAll("div.body");
|
||||
const body = divBody.length ? divBody[0] : document.querySelector("body");
|
||||
window.setTimeout(() => {
|
||||
terms.forEach((term) => _highlightText(body, term, "highlighted"));
|
||||
}, 10);
|
||||
|
||||
const searchBox = document.getElementById("searchbox");
|
||||
if (searchBox === null) return;
|
||||
searchBox.appendChild(
|
||||
document
|
||||
.createRange()
|
||||
.createContextualFragment(
|
||||
'<p class="highlight-link">' +
|
||||
'<a href="javascript:SphinxHighlight.hideSearchWords()">' +
|
||||
_("Hide Search Matches") +
|
||||
"</a></p>"
|
||||
)
|
||||
);
|
||||
},
|
||||
|
||||
/**
|
||||
* helper function to hide the search marks again
|
||||
*/
|
||||
hideSearchWords: () => {
|
||||
document
|
||||
.querySelectorAll("#searchbox .highlight-link")
|
||||
.forEach((el) => el.remove());
|
||||
document
|
||||
.querySelectorAll("span.highlighted")
|
||||
.forEach((el) => el.classList.remove("highlighted"));
|
||||
localStorage.removeItem("sphinx_highlight_terms")
|
||||
},
|
||||
|
||||
initEscapeListener: () => {
|
||||
// only install a listener if it is really needed
|
||||
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
|
||||
|
||||
document.addEventListener("keydown", (event) => {
|
||||
// bail for input elements
|
||||
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
|
||||
// bail with special keys
|
||||
if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
|
||||
if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
|
||||
SphinxHighlight.hideSearchWords();
|
||||
event.preventDefault();
|
||||
}
|
||||
});
|
||||
},
|
||||
};
|
||||
|
||||
_ready(SphinxHighlight.highlightSearchWords);
|
||||
_ready(SphinxHighlight.initEscapeListener);
|
2042
docs/build/html/_static/underscore-1.13.1.js
vendored
2042
docs/build/html/_static/underscore-1.13.1.js
vendored
File diff suppressed because it is too large
Load Diff
6
docs/build/html/_static/underscore.js
vendored
6
docs/build/html/_static/underscore.js
vendored
File diff suppressed because one or more lines are too long
39
docs/build/html/contributing.html
vendored
39
docs/build/html/contributing.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Contributing to CPL — Common Python Library documentation</title>
|
||||
@ -11,15 +11,15 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="CLI reference" href="cpl_cli.html" />
|
||||
<link rel="next" title="Deprecated" href="deprecated.html" />
|
||||
<link rel="prev" title="Using cpl g & cpl n templating" href="tutorials.templating.html" />
|
||||
</head>
|
||||
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -57,6 +61,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||||
@ -77,8 +82,8 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li>Contributing to CPL</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item active">Contributing to CPL</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/contributing.md.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -92,22 +97,22 @@
|
||||
<h1>Contributing to CPL<a class="headerlink" href="#contributing-to-cpl" title="Permalink to this heading"></a></h1>
|
||||
<p>We would love for you to contribute to CPL and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:</p>
|
||||
<ul class="simple">
|
||||
<li><p><span class="xref myst">Issuses and Bugs</span></p></li>
|
||||
<li><p><span class="xref myst">Feature Request</span></p></li>
|
||||
<li><p><span class="xref myst">Submission Guidelines</span></p></li>
|
||||
<li><p><span class="xref myst">Coding Rules</span></p></li>
|
||||
<li><p><span class="xref myst">License</span></p></li>
|
||||
<li><p><a class="reference internal" href="#found-a-bug"><span class="xref myst">Issuses and Bugs</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#feature-request"><span class="xref myst">Feature Request</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#submission-guidelines"><span class="xref myst">Submission Guidelines</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#coding-rules"><span class="xref myst">Coding Rules</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#license"><span class="xref myst">License</span></a></p></li>
|
||||
</ul>
|
||||
<section id="found-a-bug">
|
||||
<h2>Found a Bug?<a class="headerlink" href="#found-a-bug" title="Permalink to this heading"></a></h2>
|
||||
<p>If you find a bug in the source code, you can help us by <span class="xref myst">submitting an issue</span> to our <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">Gitea Repository</a>. Even better, you can <span class="xref myst">submit a Pull Request</span> with a fix.</p>
|
||||
<p>If you find a bug in the source code, you can help us by <a class="reference internal" href="#submitting-an-issue"><span class="xref myst">submitting an issue</span></a> to our <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">Gitea Repository</a>. Even better, you can <a class="reference internal" href="#submitting-a-pull-request"><span class="xref myst">submit a Pull Request</span></a> with a fix.</p>
|
||||
</section>
|
||||
<section id="feature-request">
|
||||
<h2>Feature Request<a class="headerlink" href="#feature-request" title="Permalink to this heading"></a></h2>
|
||||
<p>You can request a new feature by submitting an issue to our <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">Gitea Repository</a>. If you would like to implement a new feature, please consider the size of the change in order to determine the right steps to proceed:</p>
|
||||
<p>For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.</p>
|
||||
<p>Note: Adding a new topic to the documentation, or significantly re-writing a topic, counts as a major feature.</p>
|
||||
<p>Small Features can be crafted and directly submitted as a <span class="xref myst">Pull Request</span>.</p>
|
||||
<p>Small Features can be crafted and directly submitted as a <a class="reference internal" href="#submit-pr"><span class="xref myst">Pull Request</span></a>.</p>
|
||||
</section>
|
||||
<section id="submission-guidelines">
|
||||
<h2>Submission Guidelines<a class="headerlink" href="#submission-guidelines" title="Permalink to this heading"></a></h2>
|
||||
@ -151,7 +156,7 @@
|
||||
</section>
|
||||
<section id="reviewing-a-pull-request">
|
||||
<h3>Reviewing a Pull Request<a class="headerlink" href="#reviewing-a-pull-request" title="Permalink to this heading"></a></h3>
|
||||
<p>The sh-edraft.de team reserves the right not to accept pull requests from community members who haven’t been good citizens of the community. Such behavior includes not following the CPL <span class="xref myst">coding rules</span> and applies within or outside of CPL managed channels.</p>
|
||||
<p>The sh-edraft.de team reserves the right not to accept pull requests from community members who haven’t been good citizens of the community. Such behavior includes not following the CPL <a class="reference internal" href="#coding-rules"><span class="xref myst">coding rules</span></a> and applies within or outside of CPL managed channels.</p>
|
||||
<section id="addressing-review-feedback">
|
||||
<h4>Addressing review feedback<a class="headerlink" href="#addressing-review-feedback" title="Permalink to this heading"></a></h4>
|
||||
<p>If we ask for changes via code reviews then:</p>
|
||||
@ -190,7 +195,7 @@ See <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/cp
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="tutorials.templating.html" class="btn btn-neutral float-left" title="Using cpl g & cpl n templating" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_cli.html" class="btn btn-neutral float-right" title="CLI reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="deprecated.html" class="btn btn-neutral float-right" title="Deprecated" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
37
docs/build/html/cpl_cli.add.html
vendored
37
docs/build/html/cpl_cli.add.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl add — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,6 +46,7 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_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>
|
||||
@ -84,9 +89,9 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||
<li>cpl add</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl add</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_cli.add.md.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -101,9 +106,9 @@
|
||||
<section id="contents">
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><span class="xref myst">Description</span></p></li>
|
||||
<li><p><span class="xref myst">Arguments</span></p></li>
|
||||
<li><p><span class="xref myst">Flags</span></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#flags"><span class="xref myst">Flags</span></a></p></li>
|
||||
</ul>
|
||||
<p>Removes a project from workspace.</p>
|
||||
<p>cpl <strong>add</strong> <em><source-project></em> <em><target-project></em> <br>
|
||||
@ -117,11 +122,11 @@ cpl <strong>A</strong> <em><source-project></em> <em><target-project>
|
||||
</section>
|
||||
<section id="arguments">
|
||||
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this heading"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
<th class="text-center head"><p>Description</p></th>
|
||||
<th class="text-center head"><p>Value type</p></th>
|
||||
<th class="head text-center"><p>Description</p></th>
|
||||
<th class="head text-center"><p>Value type</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
@ -138,10 +143,10 @@ cpl <strong>A</strong> <em><source-project></em> <em><target-project>
|
||||
</section>
|
||||
<section id="flags">
|
||||
<h2>Flags<a class="headerlink" href="#flags" title="Permalink to this heading"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
<th class="text-center head"><p>Description</p></th>
|
||||
<th class="head text-center"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
|
23
docs/build/html/cpl_cli.build.html
vendored
23
docs/build/html/cpl_cli.build.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl build — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,6 +46,7 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
|
||||
@ -82,9 +87,9 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||
<li>cpl build</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl build</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_cli.build.md.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -99,7 +104,7 @@
|
||||
<section id="contents">
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><span class="xref myst">Description</span></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
|
||||
</ul>
|
||||
<!-- - [Arguments](#arguments) -->
|
||||
<p>Copies an python app into an output directory named build/ at the given output path. Must be executed within a CPL workspace or project directory</p>
|
||||
|
39
docs/build/html/cpl_cli.generate.html
vendored
39
docs/build/html/cpl_cli.generate.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl generate — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,6 +46,7 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
|
||||
@ -84,9 +89,9 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||
<li>cpl generate</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl generate</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_cli.generate.md.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -101,9 +106,9 @@
|
||||
<section id="contents">
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><span class="xref myst">Description</span></p></li>
|
||||
<li><p><span class="xref myst">Arguments</span></p></li>
|
||||
<li><p><span class="xref myst">Schematics</span></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#schematics"><span class="xref myst">Schematics</span></a></p></li>
|
||||
</ul>
|
||||
<p>Generate a file based on schematic.</p>
|
||||
<p>cpl <strong>generate</strong> <em><schematic></em> <em><name></em> <br>
|
||||
@ -117,11 +122,11 @@ cpl <strong>G</strong> <em><schematic></em> <em><name></em></p>
|
||||
</section>
|
||||
<section id="arguments">
|
||||
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this heading"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
<th class="text-center head"><p>Description</p></th>
|
||||
<th class="text-center head"><p>Value type</p></th>
|
||||
<th class="head text-center"><p>Description</p></th>
|
||||
<th class="head text-center"><p>Value type</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
@ -142,11 +147,11 @@ cpl <strong>G</strong> <em><schematic></em> <em><name></em></p>
|
||||
</section>
|
||||
<section id="schematics">
|
||||
<h2>Schematics<a class="headerlink" href="#schematics" title="Permalink to this heading"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Schematic</p></th>
|
||||
<th class="text-center head"><p>Description</p></th>
|
||||
<th class="text-center head"><p>Arguments</p></th>
|
||||
<th class="head text-center"><p>Description</p></th>
|
||||
<th class="head text-center"><p>Arguments</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
|
31
docs/build/html/cpl_cli.help.html
vendored
31
docs/build/html/cpl_cli.help.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl help — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,6 +46,7 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
|
||||
@ -83,9 +88,9 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||
<li>cpl help</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl help</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_cli.help.md.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -100,8 +105,8 @@
|
||||
<section id="contents">
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><span class="xref myst">Description</span></p></li>
|
||||
<li><p><span class="xref myst">Arguments</span></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
</ul>
|
||||
<p>Lists available command and their short descriptions.</p>
|
||||
<p>cpl <strong>help</strong> <em><command></em> <br>
|
||||
@ -114,11 +119,11 @@ cpl <strong>H</strong> <em><command></em></p>
|
||||
</section>
|
||||
<section id="arguments">
|
||||
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this heading"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
<th class="text-center head"><p>Description</p></th>
|
||||
<th class="text-center head"><p>Value type</p></th>
|
||||
<th class="head text-center"><p>Description</p></th>
|
||||
<th class="head text-center"><p>Value type</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
|
23
docs/build/html/cpl_cli.html
vendored
23
docs/build/html/cpl_cli.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>CLI reference — Common Python Library documentation</title>
|
||||
@ -11,16 +11,16 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="CLI Overview and Command Reference" href="cpl_cli.overview.html" />
|
||||
<link rel="prev" title="Contributing to CPL" href="contributing.html" />
|
||||
<link rel="prev" title="Deprecated" href="deprecated.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,6 +46,7 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">CLI reference</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
|
||||
@ -78,8 +83,8 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li>CLI reference</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item active">CLI reference</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_cli.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -177,7 +182,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="contributing.html" class="btn btn-neutral float-left" title="Contributing to CPL" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="deprecated.html" class="btn btn-neutral float-left" title="Deprecated" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_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>
|
||||
</div>
|
||||
|
||||
|
35
docs/build/html/cpl_cli.install.html
vendored
35
docs/build/html/cpl_cli.install.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl install — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,6 +46,7 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
|
||||
@ -84,9 +89,9 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||
<li>cpl install</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl install</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_cli.install.md.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -101,8 +106,8 @@
|
||||
<section id="contents">
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><span class="xref myst">Description</span></p></li>
|
||||
<li><p><span class="xref myst">Arguments</span></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
</ul>
|
||||
<p>Installs given package via pip</p>
|
||||
<p>cpl <strong>install</strong> <em><package></em> <br>
|
||||
@ -116,11 +121,11 @@ Without given package it will install the depedencies of the CPL project your in
|
||||
</section>
|
||||
<section id="arguments">
|
||||
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this heading"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
<th class="text-center head"><p>Description</p></th>
|
||||
<th class="text-center head"><p>Value type</p></th>
|
||||
<th class="head text-center"><p>Description</p></th>
|
||||
<th class="head text-center"><p>Value type</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
@ -133,10 +138,10 @@ Without given package it will install the depedencies of the CPL project your in
|
||||
</section>
|
||||
<section id="flags">
|
||||
<h2>Flags<a class="headerlink" href="#flags" title="Permalink to this heading"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
<th class="text-center head"><p>Description</p></th>
|
||||
<th class="head text-center"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
|
43
docs/build/html/cpl_cli.new.html
vendored
43
docs/build/html/cpl_cli.new.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl new — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,6 +46,7 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
|
||||
@ -84,9 +89,9 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||
<li>cpl new</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl new</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_cli.new.md.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -101,9 +106,9 @@
|
||||
<section id="contents">
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><span class="xref myst">Description</span></p></li>
|
||||
<li><p><span class="xref myst">Arguments</span></p></li>
|
||||
<li><p><span class="xref myst">Project types</span></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#project-types"><span class="xref myst">Project types</span></a></p></li>
|
||||
</ul>
|
||||
<p>Generates a workspace and initial project or add a project to workspace.</p>
|
||||
<p>cpl <strong>new</strong> <em><type></em> <em><name></em><br>
|
||||
@ -115,16 +120,16 @@ cpl <strong>N</strong> <em><type></em> <em><name></em></p>
|
||||
<p>Generates a workspace and initial project or add a project to workspace.</p>
|
||||
<p>You can define custom project types by creating templates in a <code class="docutils literal notranslate"><span class="pre">.cpl</span></code> folder.</p>
|
||||
<p>If the command is running in a CPL workspace, it will add the new project to the workspace.</p>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
<th class="text-center head"><p>Description</p></th>
|
||||
<th class="text-center head"><p>Value type</p></th>
|
||||
<th class="head text-center"><p>Description</p></th>
|
||||
<th class="head text-center"><p>Value type</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre"><type></span></code></p></td>
|
||||
<td class="text-center"><p>The type of the project, see <span class="xref myst">types</span></p></td>
|
||||
<td class="text-center"><p>The type of the project, see <a class="reference internal" href="#project-types"><span class="xref myst">types</span></a></p></td>
|
||||
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre"><name></span></code></p></td>
|
||||
@ -140,10 +145,10 @@ cpl <strong>N</strong> <em><type></em> <em><name></em></p>
|
||||
</section>
|
||||
<section id="project-types">
|
||||
<h2>Project types<a class="headerlink" href="#project-types" title="Permalink to this heading"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Project type</p></th>
|
||||
<th class="text-center head"><p>Description</p></th>
|
||||
<th class="head text-center"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
@ -158,10 +163,10 @@ cpl <strong>N</strong> <em><type></em> <em><name></em></p>
|
||||
</section>
|
||||
<section id="flags">
|
||||
<h2>Flags<a class="headerlink" href="#flags" title="Permalink to this heading"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
<th class="text-center head"><p>Description</p></th>
|
||||
<th class="head text-center"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
|
37
docs/build/html/cpl_cli.overview.html
vendored
37
docs/build/html/cpl_cli.overview.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>CLI Overview and Command Reference — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,6 +46,7 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1 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-l3"><a class="reference internal" href="#table-of-contents">Table of Contents</a></li>
|
||||
@ -88,9 +93,9 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||
<li>CLI Overview and Command Reference</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="breadcrumb-item active">CLI Overview and Command Reference</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_cli.overview.md.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -105,11 +110,11 @@
|
||||
<section id="table-of-contents">
|
||||
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this heading"></a></h2>
|
||||
<ol class="arabic simple">
|
||||
<li><p><span class="xref myst">Install CPL</span></p></li>
|
||||
<li><p><span class="xref myst">Install CPL CLI</span></p></li>
|
||||
<li><p><span class="xref myst">Basic workflow</span></p></li>
|
||||
<li><p><span class="xref myst">CLI command-language syntax</span></p></li>
|
||||
<li><p><span class="xref myst">Command overview</span></p></li>
|
||||
<li><p><a class="reference internal" href="#setup#install-the-package"><span class="xref myst">Install CPL</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#setup#install-the-cli"><span class="xref myst">Install CPL CLI</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#basic-workflow"><span class="xref myst">Basic workflow</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#cli-command-language-syntax"><span class="xref myst">CLI command-language syntax</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#command-overview"><span class="xref myst">Command overview</span></a></p></li>
|
||||
</ol>
|
||||
</section>
|
||||
<section id="basic-workflow">
|
||||
@ -140,11 +145,11 @@ cpl<span class="w"> </span>start
|
||||
</section>
|
||||
<section id="command-overview">
|
||||
<h2>Command overview<a class="headerlink" href="#command-overview" title="Permalink to this heading"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Command</p></th>
|
||||
<th class="text-center head"><p>Alias</p></th>
|
||||
<th class="text-center head"><p>Description</p></th>
|
||||
<th class="head text-center"><p>Alias</p></th>
|
||||
<th class="head text-center"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
|
26
docs/build/html/cpl_cli.publish.html
vendored
26
docs/build/html/cpl_cli.publish.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl publish — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,6 +46,7 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
|
||||
@ -82,9 +87,9 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||
<li>cpl publish</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl publish</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_cli.publish.md.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -99,7 +104,7 @@
|
||||
<section id="contents">
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><span class="xref myst">Description</span></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
|
||||
</ul>
|
||||
<!-- - [Arguments](#arguments) -->
|
||||
<p>Prepares files for publish into an output directory named dist/ at the given output path and executes <code class="docutils literal notranslate"><span class="pre">setup.py</span></code>.</p>
|
||||
@ -117,7 +122,8 @@ The command executes the <code class="docutils literal notranslate"><span class=
|
||||
|
||||
| Argument | Description | Value type |
|
||||
| ------------- |:-------------:|:----------------:|
|
||||
| ```<project>``` | The name of the project to build. Can be an console or a library. | ```str``` --></section>
|
||||
| ```<project>``` | The name of the project to build. Can be an console or a library. | ```str``` -->
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
|
35
docs/build/html/cpl_cli.remove.html
vendored
35
docs/build/html/cpl_cli.remove.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl remove — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,6 +46,7 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
|
||||
@ -84,9 +89,9 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||
<li>cpl remove</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl remove</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_cli.remove.md.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -101,8 +106,8 @@
|
||||
<section id="contents">
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><span class="xref myst">Description</span></p></li>
|
||||
<li><p><span class="xref myst">Arguments</span></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
</ul>
|
||||
<p>Removes a project from workspace.</p>
|
||||
<p>cpl <strong>remove</strong> <em><project></em> <br>
|
||||
@ -116,11 +121,11 @@ cpl <strong>R</strong> <em><project></em></p>
|
||||
</section>
|
||||
<section id="arguments">
|
||||
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this heading"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
<th class="text-center head"><p>Description</p></th>
|
||||
<th class="text-center head"><p>Value type</p></th>
|
||||
<th class="head text-center"><p>Description</p></th>
|
||||
<th class="head text-center"><p>Value type</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
@ -133,10 +138,10 @@ cpl <strong>R</strong> <em><project></em></p>
|
||||
</section>
|
||||
<section id="flags">
|
||||
<h2>Flags<a class="headerlink" href="#flags" title="Permalink to this heading"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
<th class="text-center head"><p>Description</p></th>
|
||||
<th class="head text-center"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
|
27
docs/build/html/cpl_cli.run.html
vendored
27
docs/build/html/cpl_cli.run.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl run — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,6 +46,7 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
|
||||
@ -78,9 +83,9 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||
<li>cpl run</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl run</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_cli.run.md.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -96,11 +101,11 @@
|
||||
<p>cpl <strong>run</strong> <br>
|
||||
cpl <strong>r</strong> <br>
|
||||
cpl <strong>R</strong></p>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
<th class="text-center head"><p>Description</p></th>
|
||||
<th class="text-center head"><p>Value type</p></th>
|
||||
<th class="head text-center"><p>Description</p></th>
|
||||
<th class="head text-center"><p>Value type</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
|
27
docs/build/html/cpl_cli.start.html
vendored
27
docs/build/html/cpl_cli.start.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl start — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,6 +46,7 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
|
||||
@ -78,9 +83,9 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||
<li>cpl start</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl start</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_cli.start.md.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -96,11 +101,11 @@
|
||||
<p>cpl <strong>start</strong> <br>
|
||||
cpl <strong>s</strong> <br>
|
||||
cpl <strong>S</strong></p>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
<th class="text-center head"><p>Description</p></th>
|
||||
<th class="text-center head"><p>Value type</p></th>
|
||||
<th class="head text-center"><p>Description</p></th>
|
||||
<th class="head text-center"><p>Value type</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
|
35
docs/build/html/cpl_cli.uninstall.html
vendored
35
docs/build/html/cpl_cli.uninstall.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl uninstall — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,6 +46,7 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
|
||||
@ -84,9 +89,9 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||
<li>cpl uninstall</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl uninstall</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_cli.uninstall.md.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -101,8 +106,8 @@
|
||||
<section id="contents">
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><span class="xref myst">Description</span></p></li>
|
||||
<li><p><span class="xref myst">Arguments</span></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
|
||||
</ul>
|
||||
<p>Uninstalls given package via pip</p>
|
||||
<p>cpl <strong>uninstall</strong> <em><package></em> <br>
|
||||
@ -115,11 +120,11 @@ cpl <strong>UI</strong> <em><package></em></p>
|
||||
</section>
|
||||
<section id="arguments">
|
||||
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this heading"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
<th class="text-center head"><p>Description</p></th>
|
||||
<th class="text-center head"><p>Value type</p></th>
|
||||
<th class="head text-center"><p>Description</p></th>
|
||||
<th class="head text-center"><p>Value type</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
@ -132,10 +137,10 @@ cpl <strong>UI</strong> <em><package></em></p>
|
||||
</section>
|
||||
<section id="flags">
|
||||
<h2>Flags<a class="headerlink" href="#flags" title="Permalink to this heading"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
<th class="text-center head"><p>Description</p></th>
|
||||
<th class="head text-center"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
|
25
docs/build/html/cpl_cli.update.html
vendored
25
docs/build/html/cpl_cli.update.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl update — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,6 +46,7 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
|
||||
@ -81,9 +86,9 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||
<li>cpl update</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl update</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_cli.update.md.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -101,10 +106,10 @@ cpl <strong>u</strong> <br>
|
||||
cpl <strong>U</strong></p>
|
||||
<section id="flags">
|
||||
<h2>Flags<a class="headerlink" href="#flags" title="Permalink to this heading"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
<th class="text-center head"><p>Description</p></th>
|
||||
<th class="head text-center"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
|
21
docs/build/html/cpl_cli.version.html
vendored
21
docs/build/html/cpl_cli.version.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl version — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,6 +46,7 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
|
||||
@ -78,9 +83,9 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||
<li>cpl version</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl version</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_cli.version.md.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
|
60
docs/build/html/cpl_core.application.html
vendored
60
docs/build/html/cpl_core.application.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_core.application package — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,18 +46,38 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.application package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_abc">cpl_core.application.application_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_builder">cpl_core.application.application_builder module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_builder_abc">cpl_core.application.application_builder_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_extension_abc">cpl_core.application.application_extension_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.startup_abc">cpl_core.application.startup_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.startup_extension_abc">cpl_core.application.startup_extension_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_abc">cpl_core.application.application_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC"><code class="docutils literal notranslate"><span class="pre">ApplicationABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_builder">cpl_core.application.application_builder module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.application_builder.ApplicationBuilder"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilder</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_builder_abc">cpl_core.application.application_builder_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilderABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_extension_abc">cpl_core.application.application_extension_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.application_extension_abc.ApplicationExtensionABC"><code class="docutils literal notranslate"><span class="pre">ApplicationExtensionABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.startup_abc">cpl_core.application.startup_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC"><code class="docutils literal notranslate"><span class="pre">StartupABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.startup_extension_abc">cpl_core.application.startup_extension_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.startup_extension_abc.StartupExtensionABC"><code class="docutils literal notranslate"><span class="pre">StartupExtensionABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -88,9 +112,9 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page 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 package</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl_core.application package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_core.application.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -188,7 +212,7 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.use_extension">
|
||||
<span class="sig-name descname"><span class="pre">use_extension</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extension</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.application_extension_abc.ApplicationExtensionABC" title="cpl_core.application.application_extension_abc.ApplicationExtensionABC"><span class="pre">ApplicationExtensionABC</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.application.startup_extension_abc.StartupExtensionABC" title="cpl_core.application.startup_extension_abc.StartupExtensionABC"><span class="pre">StartupExtensionABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_builder.ApplicationBuilder" title="cpl_core.application.application_builder.ApplicationBuilder"><span class="pre">ApplicationBuilder</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_extension" title="Permalink to this definition"></a></dt>
|
||||
<span class="sig-name descname"><span class="pre">use_extension</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extension</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.application_extension_abc.ApplicationExtensionABC" title="cpl_core.application.application_extension_abc.ApplicationExtensionABC"><span class="pre">ApplicationExtensionABC</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.application.startup_extension_abc.StartupExtensionABC" title="cpl_core.application.startup_extension_abc.StartupExtensionABC"><span class="pre">StartupExtensionABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_builder.ApplicationBuilder" title="cpl_core.application.application_builder.ApplicationBuilder"><span class="pre">ApplicationBuilder</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_extension" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
@ -338,15 +362,16 @@ env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_co
|
||||
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL core package</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">copyright</dt>
|
||||
<dt class="field-odd">copyright<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ol class="loweralpha simple" start="3">
|
||||
<li><p>2020 - 2023 sh-edraft.de</p></li>
|
||||
</ol>
|
||||
</dd>
|
||||
<dt class="field-even">license</dt>
|
||||
<dt class="field-even">license<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.application.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
@ -371,7 +396,6 @@ env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_co
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
123
docs/build/html/cpl_core.configuration.html
vendored
123
docs/build/html/cpl_core.configuration.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_core.configuration package — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,25 +46,64 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.configuration package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_abc">cpl_core.configuration.argument_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_builder">cpl_core.configuration.argument_builder module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_executable_abc">cpl_core.configuration.argument_executable_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_type_enum">cpl_core.configuration.argument_type_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration">cpl_core.configuration.configuration module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration_abc">cpl_core.configuration.configuration_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration_model_abc">cpl_core.configuration.configuration_model_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration_variable_name_enum">cpl_core.configuration.configuration_variable_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.executable_argument">cpl_core.configuration.executable_argument module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.flag_argument">cpl_core.configuration.flag_argument module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.validator_abc">cpl_core.configuration.validator_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.variable_argument">cpl_core.configuration.variable_argument module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_abc">cpl_core.configuration.argument_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.argument_abc.ArgumentABC"><code class="docutils literal notranslate"><span class="pre">ArgumentABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_builder">cpl_core.configuration.argument_builder module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.argument_builder.ArgumentBuilder"><code class="docutils literal notranslate"><span class="pre">ArgumentBuilder</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_executable_abc">cpl_core.configuration.argument_executable_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC"><code class="docutils literal notranslate"><span class="pre">ArgumentExecutableABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_type_enum">cpl_core.configuration.argument_type_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum"><code class="docutils literal notranslate"><span class="pre">ArgumentTypeEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration">cpl_core.configuration.configuration module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.configuration.Configuration"><code class="docutils literal notranslate"><span class="pre">Configuration</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration_abc">cpl_core.configuration.configuration_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="docutils literal notranslate"><span class="pre">ConfigurationABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration_model_abc">cpl_core.configuration.configuration_model_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.base_func"><code class="docutils literal notranslate"><span class="pre">base_func()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration_variable_name_enum">cpl_core.configuration.configuration_variable_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum"><code class="docutils literal notranslate"><span class="pre">ConfigurationVariableNameEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.executable_argument">cpl_core.configuration.executable_argument module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.executable_argument.ExecutableArgument"><code class="docutils literal notranslate"><span class="pre">ExecutableArgument</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.flag_argument">cpl_core.configuration.flag_argument module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.flag_argument.FlagArgument"><code class="docutils literal notranslate"><span class="pre">FlagArgument</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.validator_abc">cpl_core.configuration.validator_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.validator_abc.ValidatorABC"><code class="docutils literal notranslate"><span class="pre">ValidatorABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.variable_argument">cpl_core.configuration.variable_argument module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.variable_argument.VariableArgument"><code class="docutils literal notranslate"><span class="pre">VariableArgument</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -94,9 +137,9 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page 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.configuration package</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl_core.configuration package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_core.configuration.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -115,7 +158,7 @@
|
||||
<span id="cpl-core-configuration-argument-abc-module"></span><h2>cpl_core.configuration.argument_abc module<a class="headerlink" href="#module-cpl_core.configuration.argument_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.argument_abc.ArgumentABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.argument_abc.</span></span><span class="sig-name descname"><span class="pre">ArgumentABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.argument_abc.</span></span><span class="sig-name descname"><span class="pre">ArgumentABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.argument_abc.ArgumentABC.add_console_argument">
|
||||
@ -168,7 +211,7 @@
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.argument_builder.ArgumentBuilder.build_argument">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum" title="cpl_core.configuration.argument_type_enum.ArgumentTypeEnum"><span class="pre">ArgumentTypeEnum</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.executable_argument.ExecutableArgument" title="cpl_core.configuration.executable_argument.ExecutableArgument"><span class="pre">ExecutableArgument</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.configuration.flag_argument.FlagArgument" title="cpl_core.configuration.flag_argument.FlagArgument"><span class="pre">FlagArgument</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.configuration.variable_argument.VariableArgument" title="cpl_core.configuration.variable_argument.VariableArgument"><span class="pre">VariableArgument</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.configuration.argument_builder.ArgumentBuilder.build_argument" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum" title="cpl_core.configuration.argument_type_enum.ArgumentTypeEnum"><span class="pre">ArgumentTypeEnum</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.configuration.executable_argument.ExecutableArgument" title="cpl_core.configuration.executable_argument.ExecutableArgument"><span class="pre">ExecutableArgument</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.configuration.flag_argument.FlagArgument" title="cpl_core.configuration.flag_argument.FlagArgument"><span class="pre">FlagArgument</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.configuration.variable_argument.VariableArgument" title="cpl_core.configuration.variable_argument.VariableArgument"><span class="pre">VariableArgument</span></a></span></span><a class="headerlink" href="#cpl_core.configuration.argument_builder.ArgumentBuilder.build_argument" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -262,7 +305,7 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.add_json_file">
|
||||
<span class="sig-name descname"><span class="pre">add_json_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">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="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">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="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_json_file" title="Permalink to this definition"></a></dt>
|
||||
<span class="sig-name descname"><span class="pre">add_json_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_json_file" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Reads and saves settings from given json file</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@ -286,7 +329,7 @@
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.argument_error_function">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">argument_error_function</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.argument_error_function" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">argument_error_function</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.argument_error_function" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
@ -339,7 +382,7 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.get_configuration">
|
||||
<span class="sig-name descname"><span class="pre">get_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.get_configuration" title="Permalink to this definition"></a></dt>
|
||||
<span class="sig-name descname"><span class="pre">get_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.get_configuration" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns value from configuration by given type</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@ -354,7 +397,7 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.parse_console_arguments">
|
||||
<span class="sig-name descname"><span class="pre">parse_console_arguments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">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="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.parse_console_arguments" title="Permalink to this definition"></a></dt>
|
||||
<span class="sig-name descname"><span class="pre">parse_console_arguments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.parse_console_arguments" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Reads the console arguments</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@ -419,7 +462,7 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_json_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">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="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">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="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_json_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Reads and saves settings from given json file</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@ -443,7 +486,7 @@
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">argument_error_function</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">argument_error_function</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
@ -496,7 +539,7 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns value from configuration by given type</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@ -535,8 +578,9 @@
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts attributes to dict</p>
|
||||
<span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>DEPRECATED: Set attributes as typed arguments in __init__ instead. See <> for further information
|
||||
Converts attributes to dict</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><p>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
|
||||
</dd>
|
||||
@ -545,6 +589,11 @@
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_model_abc.base_func">
|
||||
<span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_model_abc.</span></span><span class="sig-name descname"><span class="pre">base_func</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_model_abc.base_func" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.configuration.configuration_variable_name_enum">
|
||||
<span id="cpl-core-configuration-configuration-variable-name-enum-module"></span><h2>cpl_core.configuration.configuration_variable_name_enum module<a class="headerlink" href="#module-cpl_core.configuration.configuration_variable_name_enum" title="Permalink to this heading"></a></h2>
|
||||
@ -580,7 +629,7 @@
|
||||
<span id="cpl-core-configuration-executable-argument-module"></span><h2>cpl_core.configuration.executable_argument module<a class="headerlink" href="#module-cpl_core.configuration.executable_argument" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.executable_argument.ExecutableArgument">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.executable_argument.</span></span><span class="sig-name descname"><span class="pre">ExecutableArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC" title="cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC"><span class="pre">ArgumentExecutableABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validators</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.validator_abc.ValidatorABC" title="cpl_core.configuration.validator_abc.ValidatorABC"><span class="pre">cpl_core.configuration.validator_abc.ValidatorABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.executable_argument.ExecutableArgument" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.executable_argument.</span></span><span class="sig-name descname"><span class="pre">ExecutableArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC" title="cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC"><span class="pre">ArgumentExecutableABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validators</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.validator_abc.ValidatorABC" title="cpl_core.configuration.validator_abc.ValidatorABC"><span class="pre">cpl_core.configuration.validator_abc.ValidatorABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.executable_argument.ExecutableArgument" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="cpl_core.configuration.argument_abc.ArgumentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentABC</span></code></a></p>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.executable_argument.ExecutableArgument.executable_type">
|
||||
@ -610,7 +659,7 @@
|
||||
<span id="cpl-core-configuration-flag-argument-module"></span><h2>cpl_core.configuration.flag_argument module<a class="headerlink" href="#module-cpl_core.configuration.flag_argument" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.flag_argument.FlagArgument">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.flag_argument.</span></span><span class="sig-name descname"><span class="pre">FlagArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.flag_argument.FlagArgument" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.flag_argument.</span></span><span class="sig-name descname"><span class="pre">FlagArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.flag_argument.FlagArgument" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="cpl_core.configuration.argument_abc.ArgumentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentABC</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
@ -633,7 +682,7 @@
|
||||
<span id="cpl-core-configuration-variable-argument-module"></span><h2>cpl_core.configuration.variable_argument module<a class="headerlink" href="#module-cpl_core.configuration.variable_argument" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.variable_argument.VariableArgument">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.variable_argument.</span></span><span class="sig-name descname"><span class="pre">VariableArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value_token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.variable_argument.VariableArgument" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.variable_argument.</span></span><span class="sig-name descname"><span class="pre">VariableArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value_token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.variable_argument.VariableArgument" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="cpl_core.configuration.argument_abc.ArgumentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.variable_argument.VariableArgument.set_value">
|
||||
@ -659,15 +708,16 @@
|
||||
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL core package</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">copyright</dt>
|
||||
<dt class="field-odd">copyright<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ol class="loweralpha simple" start="3">
|
||||
<li><p>2020 - 2023 sh-edraft.de</p></li>
|
||||
</ol>
|
||||
</dd>
|
||||
<dt class="field-even">license</dt>
|
||||
<dt class="field-even">license<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
@ -692,7 +742,6 @@
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
67
docs/build/html/cpl_core.console.html
vendored
67
docs/build/html/cpl_core.console.html
vendored
File diff suppressed because one or more lines are too long
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_core.database.connection package — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,6 +46,7 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
|
||||
@ -87,10 +92,10 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page 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><a href="cpl_core.database.html">cpl_core.database package</a> »</li>
|
||||
<li>cpl_core.database.connection package</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.database.html">cpl_core.database package</a></li>
|
||||
<li class="breadcrumb-item active">cpl_core.database.connection package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_core.database.connection.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -177,15 +182,16 @@
|
||||
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL core package</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">copyright</dt>
|
||||
<dt class="field-odd">copyright<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ol class="loweralpha simple" start="3">
|
||||
<li><p>2020 - 2023 sh-edraft.de</p></li>
|
||||
</ol>
|
||||
</dd>
|
||||
<dt class="field-even">license</dt>
|
||||
<dt class="field-even">license<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.connection.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.connection.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
@ -210,7 +216,6 @@
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
29
docs/build/html/cpl_core.database.context.html
vendored
29
docs/build/html/cpl_core.database.context.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_core.database.context package — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,6 +46,7 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
|
||||
@ -87,10 +92,10 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page 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><a href="cpl_core.database.html">cpl_core.database package</a> »</li>
|
||||
<li>cpl_core.database.context package</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.database.html">cpl_core.database package</a></li>
|
||||
<li class="breadcrumb-item active">cpl_core.database.context package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_core.database.context.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -201,15 +206,16 @@
|
||||
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL core package</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">copyright</dt>
|
||||
<dt class="field-odd">copyright<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ol class="loweralpha simple" start="3">
|
||||
<li><p>2020 - 2023 sh-edraft.de</p></li>
|
||||
</ol>
|
||||
</dd>
|
||||
<dt class="field-even">license</dt>
|
||||
<dt class="field-even">license<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.context.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
@ -234,7 +240,6 @@
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
125
docs/build/html/cpl_core.database.html
vendored
125
docs/build/html/cpl_core.database.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_core.database package — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,6 +46,7 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
|
||||
@ -54,11 +59,21 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings">cpl_core.database.database_settings module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.table_abc">cpl_core.database.table_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings">cpl_core.database.database_settings module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.database.database_settings.DatabaseSettings"><code class="docutils literal notranslate"><span class="pre">DatabaseSettings</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">DatabaseSettingsNameEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.table_abc">cpl_core.database.table_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.database.table_abc.TableABC"><code class="docutils literal notranslate"><span class="pre">TableABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.database.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -90,9 +105,9 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page 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.database package</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl_core.database package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_core.database.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -110,20 +125,66 @@
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.database.connection.html">cpl_core.database.connection package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#module-cpl_core.database.connection.database_connection">cpl_core.database.connection.database_connection module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#module-cpl_core.database.connection.database_connection_abc">cpl_core.database.connection.database_connection_abc module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#module-cpl_core.database.connection.database_connection">cpl_core.database.connection.database_connection module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection.DatabaseConnection"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection.DatabaseConnection.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection.connect()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection.DatabaseConnection.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection.cursor</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection.DatabaseConnection.server"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection.server</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#module-cpl_core.database.connection.database_connection_abc">cpl_core.database.connection.database_connection_abc module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC.connect()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC.cursor</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.server"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC.server</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#module-cpl_core.database.connection">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#module-cpl_core.database.context.database_context">cpl_core.database.context.database_context module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#module-cpl_core.database.context.database_context_abc">cpl_core.database.context.database_context_abc module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#module-cpl_core.database.context.database_context">cpl_core.database.context.database_context module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext"><code class="docutils literal notranslate"><span class="pre">DatabaseContext</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.connect()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.cursor</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext.save_changes"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.save_changes()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext.select"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.select()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#module-cpl_core.database.context.database_context_abc">cpl_core.database.context.database_context_abc module</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.connect()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.cursor</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC.save_changes"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.save_changes()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC.select"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.select()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#module-cpl_core.database.context">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -138,60 +199,52 @@
|
||||
<span id="cpl-core-database-database-settings-module"></span><h2>cpl_core.database.database_settings module<a class="headerlink" href="#module-cpl_core.database.database_settings" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.database_settings.</span></span><span class="sig-name descname"><span class="pre">DatabaseSettings</span></span><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.database_settings.</span></span><span class="sig-name descname"><span class="pre">DatabaseSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">databse</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">charset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_unicode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffered</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth_plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
|
||||
<p>Represents settings for the database connection</p>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.auth_plugin">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">auth_plugin</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.auth_plugin" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">auth_plugin</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.auth_plugin" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.buffered">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">buffered</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.buffered" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">buffered</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.buffered" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.charset">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">charset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.charset" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">charset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.charset" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.database">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">database</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.database" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">database</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.database" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.from_dict">
|
||||
<span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.from_dict" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets attributes from given dict</p>
|
||||
<p>Parameter:
|
||||
settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.host">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.host" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.host" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.password">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">password</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.password" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">password</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.password" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.port">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.port" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.port" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.use_unicode">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">use_unicode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.use_unicode" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">use_unicode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.use_unicode" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.user">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.user" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.user" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -292,15 +345,16 @@ settings: <code class="xref py py-class docutils literal notranslate"><span clas
|
||||
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL core package</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">copyright</dt>
|
||||
<dt class="field-odd">copyright<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ol class="loweralpha simple" start="3">
|
||||
<li><p>2020 - 2023 sh-edraft.de</p></li>
|
||||
</ol>
|
||||
</dd>
|
||||
<dt class="field-even">license</dt>
|
||||
<dt class="field-even">license<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
@ -325,7 +379,6 @@ settings: <code class="xref py py-class docutils literal notranslate"><span clas
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
279
docs/build/html/cpl_core.dependency_injection.html
vendored
279
docs/build/html/cpl_core.dependency_injection.html
vendored
@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_core.dependency_injection package — Common Python Library documentation</title>
|
||||
@ -11,11 +11,11 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@ -28,11 +28,15 @@
|
||||
<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 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="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
@ -42,6 +46,7 @@
|
||||
<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="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
|
||||
@ -50,17 +55,45 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html">cpl_core.database package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.dependency_injection package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.scope">cpl_core.dependency_injection.scope module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.scope_abc">cpl_core.dependency_injection.scope_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.scope_builder">cpl_core.dependency_injection.scope_builder module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_collection">cpl_core.dependency_injection.service_collection module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_collection_abc">cpl_core.dependency_injection.service_collection_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_descriptor">cpl_core.dependency_injection.service_descriptor module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_lifetime_enum">cpl_core.dependency_injection.service_lifetime_enum module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_provider">cpl_core.dependency_injection.service_provider module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_provider_abc">cpl_core.dependency_injection.service_provider_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.scope">cpl_core.dependency_injection.scope module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.scope.Scope"><code class="docutils literal notranslate"><span class="pre">Scope</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.scope_abc">cpl_core.dependency_injection.scope_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="docutils literal notranslate"><span class="pre">ScopeABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.scope_builder">cpl_core.dependency_injection.scope_builder module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.scope_builder.ScopeBuilder"><code class="docutils literal notranslate"><span class="pre">ScopeBuilder</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_collection">cpl_core.dependency_injection.service_collection module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection.ServiceCollection"><code class="docutils literal notranslate"><span class="pre">ServiceCollection</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_collection_abc">cpl_core.dependency_injection.service_collection_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="docutils literal notranslate"><span class="pre">ServiceCollectionABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_descriptor">cpl_core.dependency_injection.service_descriptor module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor"><code class="docutils literal notranslate"><span class="pre">ServiceDescriptor</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_lifetime_enum">cpl_core.dependency_injection.service_lifetime_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><code class="docutils literal notranslate"><span class="pre">ServiceLifetimeEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_provider">cpl_core.dependency_injection.service_provider module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider.ServiceProvider"><code class="docutils literal notranslate"><span class="pre">ServiceProvider</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_provider_abc">cpl_core.dependency_injection.service_provider_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="docutils literal notranslate"><span class="pre">ServiceProviderABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -91,9 +124,9 @@
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page 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.dependency_injection package</li>
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl_core.dependency_injection package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_core.dependency_injection.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@ -213,7 +246,7 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_scoped">
|
||||
<span class="sig-name descname"><span class="pre">add_scoped</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">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="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_scoped" title="Permalink to this definition"></a></dt>
|
||||
<span class="sig-name descname"><span class="pre">add_scoped</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_scoped" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with scoped lifetime</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@ -230,7 +263,7 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_singleton">
|
||||
<span class="sig-name descname"><span class="pre">add_singleton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_singleton" title="Permalink to this definition"></a></dt>
|
||||
<span class="sig-name descname"><span class="pre">add_singleton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_singleton" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with singleton lifetime</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@ -247,7 +280,7 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_transient">
|
||||
<span class="sig-name descname"><span class="pre">add_transient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_transient" title="Permalink to this definition"></a></dt>
|
||||
<span class="sig-name descname"><span class="pre">add_transient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_transient" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with transient lifetime</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@ -315,7 +348,7 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_scoped</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_scoped</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with scoped lifetime</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@ -332,7 +365,7 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_singleton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_singleton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with singleton lifetime</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@ -349,7 +382,7 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_transient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_transient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with transient lifetime</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@ -387,7 +420,7 @@
|
||||
<span id="cpl-core-dependency-injection-service-descriptor-module"></span><h2>cpl_core.dependency_injection.service_descriptor module<a class="headerlink" href="#module-cpl_core.dependency_injection.service_descriptor" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_descriptor.</span></span><span class="sig-name descname"><span class="pre">ServiceDescriptor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">implementation</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">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="w"> </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="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><span class="pre">ServiceLifetimeEnum</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_descriptor.</span></span><span class="sig-name descname"><span class="pre">ServiceDescriptor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">implementation</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">object</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lifetime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><span class="pre">ServiceLifetimeEnum</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>Descriptor of a service</p>
|
||||
<dl class="simple">
|
||||
@ -406,7 +439,7 @@
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.implementation">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">implementation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">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="w"> </span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.implementation" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">implementation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">object</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.implementation" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
@ -451,11 +484,13 @@
|
||||
<span id="cpl-core-dependency-injection-service-provider-module"></span><h2>cpl_core.dependency_injection.service_provider module<a class="headerlink" href="#module-cpl_core.dependency_injection.service_provider" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_provider.</span></span><span class="sig-name descname"><span class="pre">ServiceProvider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_descriptors</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor" title="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor"><span class="pre">cpl_core.dependency_injection.service_descriptor.ServiceDescriptor</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_provider.</span></span><span class="sig-name descname"><span class="pre">ServiceProvider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_descriptors</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor" title="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor"><span class="pre">cpl_core.dependency_injection.service_descriptor.ServiceDescriptor</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">DatabaseContextABC</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceProviderABC</span></code></a></p>
|
||||
<p>Provider for the services</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<section id="parameter">
|
||||
<h3>Parameter<a class="headerlink" href="#parameter" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>service_descriptors: list[<a class="reference internal" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor" title="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_descriptor.ServiceDescriptor</span></code></a>]</dt><dd><p>Descriptor of the service</p>
|
||||
</dd>
|
||||
<dt>config: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></code></a></dt><dd><p>CPL Configuration</p>
|
||||
@ -463,8 +498,7 @@
|
||||
<dt>db_context: Optional[<a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database representation</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.build_by_signature">
|
||||
<span class="sig-name descname"><span class="pre">build_by_signature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sig</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Signature</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.build_by_signature" title="Permalink to this definition"></a></dt>
|
||||
@ -472,72 +506,95 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.build_service">
|
||||
<span class="sig-name descname"><span class="pre">build_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.build_service" title="Permalink to this definition"></a></dt>
|
||||
<span class="sig-name descname"><span class="pre">build_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.build_service" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates instance of given type</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<section id="id1">
|
||||
<h4>Parameter<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>Object of the given type</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="returns">
|
||||
<h4>Returns<a class="headerlink" href="#returns" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><p>Object of the given type</p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.create_scope">
|
||||
<span class="sig-name descname"><span class="pre">create_scope</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.create_scope" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates a service scope</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<section id="id2">
|
||||
<h4>Returns<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.get_service">
|
||||
<span class="sig-name descname"><span class="pre">get_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.get_service" title="Permalink to this definition"></a></dt>
|
||||
<span class="sig-name descname"><span class="pre">get_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.get_service" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns instance of given type</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<section id="id3">
|
||||
<h4>Parameter<a class="headerlink" href="#id3" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>Object of type Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="id4">
|
||||
<h4>Returns<a class="headerlink" href="#id4" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><p>Object of type Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.get_services">
|
||||
<span class="sig-name descname"><span class="pre">get_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.get_services" title="Permalink to this definition"></a></dt>
|
||||
<span class="sig-name descname"><span class="pre">get_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.get_services" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns instance of given type</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<section id="id5">
|
||||
<h4>Parameter<a class="headerlink" href="#id5" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>Object of type list[Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="id6">
|
||||
<h4>Returns<a class="headerlink" href="#id6" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><p>Object of type list[Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.set_scope">
|
||||
<span class="sig-name descname"><span class="pre">set_scope</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.set_scope" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets the scope of service provider</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<section id="id7">
|
||||
<h4>Parameter<a class="headerlink" href="#id7" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></dt><dd><p>Service scope</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
@ -555,69 +612,95 @@
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_service">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_service" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_service" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates instance of given type</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<section id="id8">
|
||||
<h3>Parameter<a class="headerlink" href="#id8" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>Object of the given type</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="id9">
|
||||
<h3>Returns<a class="headerlink" href="#id9" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><p>Object of the given type</p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.create_scope">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_scope</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.create_scope" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates a service scope</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<section id="id10">
|
||||
<h3>Returns<a class="headerlink" href="#id10" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_service">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_service" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_service" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns instance of given type</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<section id="id11">
|
||||
<h3>Parameter<a class="headerlink" href="#id11" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>Object of type Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="id12">
|
||||
<h3>Returns<a class="headerlink" href="#id12" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><p>Object of type Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_services">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_services" title="Permalink to this definition"></a></dt>
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_services" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns instance of given type</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<section id="id13">
|
||||
<h3>Parameter<a class="headerlink" href="#id13" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>Object of type list[Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="id14">
|
||||
<h3>Returns<a class="headerlink" href="#id14" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><p>Object of type list[Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.inject">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">inject</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.inject" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Decorator to allow injection into static and class methods</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><p>f: Callable</p>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>function</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<section id="id15">
|
||||
<h3>Parameter<a class="headerlink" href="#id15" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><p>f: Callable</p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="id16">
|
||||
<h3>Returns<a class="headerlink" href="#id16" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><p>function</p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
@ -629,13 +712,15 @@
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.set_scope">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_scope</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.set_scope" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets the scope of service provider</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<section id="id17">
|
||||
<h3>Parameter<a class="headerlink" href="#id17" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></dt><dd><p>Service scope</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -647,15 +732,16 @@
|
||||
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL core package</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">copyright</dt>
|
||||
<dt class="field-odd">copyright<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ol class="loweralpha simple" start="3">
|
||||
<li><p>2020 - 2023 sh-edraft.de</p></li>
|
||||
</ol>
|
||||
</dd>
|
||||
<dt class="field-even">license</dt>
|
||||
<dt class="field-even">license<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
@ -680,7 +766,6 @@
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user