Improved docs by adding cpl_query.exceptions
This commit is contained in:
parent
6eec92243e
commit
d7881774a8
BIN
docs/build/doctrees/cli.add.doctree
vendored
BIN
docs/build/doctrees/cli.add.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.build.doctree
vendored
BIN
docs/build/doctrees/cli.build.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.generate.doctree
vendored
BIN
docs/build/doctrees/cli.generate.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.help.doctree
vendored
BIN
docs/build/doctrees/cli.help.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.install.doctree
vendored
BIN
docs/build/doctrees/cli.install.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.new.doctree
vendored
BIN
docs/build/doctrees/cli.new.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.overview.doctree
vendored
BIN
docs/build/doctrees/cli.overview.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.publish.doctree
vendored
BIN
docs/build/doctrees/cli.publish.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.remove.doctree
vendored
BIN
docs/build/doctrees/cli.remove.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.start.doctree
vendored
BIN
docs/build/doctrees/cli.start.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.uninstall.doctree
vendored
BIN
docs/build/doctrees/cli.uninstall.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.update.doctree
vendored
BIN
docs/build/doctrees/cli.update.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.version.doctree
vendored
BIN
docs/build/doctrees/cli.version.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/contributing.doctree
vendored
BIN
docs/build/doctrees/contributing.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.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.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_query.exceptions.doctree
vendored
BIN
docs/build/doctrees/cpl_query.exceptions.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.tests.doctree
vendored
BIN
docs/build/doctrees/cpl_query.tests.doctree
vendored
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/introduction.doctree
vendored
BIN
docs/build/doctrees/introduction.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/quickstart.doctree
vendored
BIN
docs/build/doctrees/quickstart.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/setup.doctree
vendored
BIN
docs/build/doctrees/setup.doctree
vendored
Binary file not shown.
2
docs/build/html/.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: 8170277cf12e5442e6180427108a8adf
|
||||
config: e947378348368955f94cb62626664e15
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
|
108
docs/build/html/_static/basic.css
vendored
108
docs/build/html/_static/basic.css
vendored
@ -130,7 +130,7 @@ ul.search li a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
ul.search li div.context {
|
||||
ul.search li p.context {
|
||||
color: #888;
|
||||
margin: 2px 0 0 30px;
|
||||
text-align: left;
|
||||
@ -277,25 +277,25 @@ p.rubric {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left {
|
||||
img.align-left, figure.align-left, .figure.align-left, object.align-left {
|
||||
clear: left;
|
||||
float: left;
|
||||
margin-right: 1em;
|
||||
}
|
||||
|
||||
img.align-right, .figure.align-right, object.align-right {
|
||||
img.align-right, figure.align-right, .figure.align-right, object.align-right {
|
||||
clear: right;
|
||||
float: right;
|
||||
margin-left: 1em;
|
||||
}
|
||||
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
img.align-center, figure.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
img.align-default, .figure.align-default {
|
||||
img.align-default, figure.align-default, .figure.align-default {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
@ -319,7 +319,8 @@ img.align-default, .figure.align-default {
|
||||
|
||||
/* -- sidebars -------------------------------------------------------------- */
|
||||
|
||||
div.sidebar {
|
||||
div.sidebar,
|
||||
aside.sidebar {
|
||||
margin: 0 0 0.5em 1em;
|
||||
border: 1px solid #ddb;
|
||||
padding: 7px;
|
||||
@ -377,12 +378,14 @@ div.body p.centered {
|
||||
/* -- content of sidebars/topics/admonitions -------------------------------- */
|
||||
|
||||
div.sidebar > :last-child,
|
||||
aside.sidebar > :last-child,
|
||||
div.topic > :last-child,
|
||||
div.admonition > :last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.sidebar::after,
|
||||
aside.sidebar::after,
|
||||
div.topic::after,
|
||||
div.admonition::after,
|
||||
blockquote::after {
|
||||
@ -455,20 +458,22 @@ td > :last-child {
|
||||
|
||||
/* -- figures --------------------------------------------------------------- */
|
||||
|
||||
div.figure {
|
||||
div.figure, figure {
|
||||
margin: 0.5em;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.figure p.caption {
|
||||
div.figure p.caption, figcaption {
|
||||
padding: 0.3em;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-number {
|
||||
div.figure p.caption span.caption-number,
|
||||
figcaption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-text {
|
||||
div.figure p.caption span.caption-text,
|
||||
figcaption span.caption-text {
|
||||
}
|
||||
|
||||
/* -- field list styles ----------------------------------------------------- */
|
||||
@ -503,6 +508,63 @@ table.hlist td {
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
/* -- object description styles --------------------------------------------- */
|
||||
|
||||
.sig {
|
||||
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
|
||||
}
|
||||
|
||||
.sig-name, code.descname {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.sig-name {
|
||||
font-size: 1.1em;
|
||||
}
|
||||
|
||||
code.descname {
|
||||
font-size: 1.2em;
|
||||
}
|
||||
|
||||
.sig-prename, code.descclassname {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
.optional {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
.sig-paren {
|
||||
font-size: larger;
|
||||
}
|
||||
|
||||
.sig-param.n {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
/* C++ specific styling */
|
||||
|
||||
.sig-inline.c-texpr,
|
||||
.sig-inline.cpp-texpr {
|
||||
font-family: unset;
|
||||
}
|
||||
|
||||
.sig.c .k, .sig.c .kt,
|
||||
.sig.cpp .k, .sig.cpp .kt {
|
||||
color: #0033B3;
|
||||
}
|
||||
|
||||
.sig.c .m,
|
||||
.sig.cpp .m {
|
||||
color: #1750EB;
|
||||
}
|
||||
|
||||
.sig.c .s, .sig.c .sc,
|
||||
.sig.cpp .s, .sig.cpp .sc {
|
||||
color: #067D17;
|
||||
}
|
||||
|
||||
|
||||
/* -- other body styles ----------------------------------------------------- */
|
||||
|
||||
@ -629,14 +691,6 @@ dl.glossary dt {
|
||||
font-size: 1.1em;
|
||||
}
|
||||
|
||||
.optional {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
.sig-paren {
|
||||
font-size: larger;
|
||||
}
|
||||
|
||||
.versionmodified {
|
||||
font-style: italic;
|
||||
}
|
||||
@ -765,8 +819,12 @@ div.code-block-caption code {
|
||||
|
||||
table.highlighttable td.linenos,
|
||||
span.linenos,
|
||||
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
|
||||
user-select: none;
|
||||
div.highlight span.gp { /* gp: Generic.Prompt */
|
||||
user-select: none;
|
||||
-webkit-user-select: text; /* Safari fallback only */
|
||||
-webkit-user-select: none; /* Chrome/Safari */
|
||||
-moz-user-select: none; /* Firefox */
|
||||
-ms-user-select: none; /* IE10+ */
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-number {
|
||||
@ -781,16 +839,6 @@ div.literal-block-wrapper {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
code.descname {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
font-size: 1.2em;
|
||||
}
|
||||
|
||||
code.descclassname {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
code.xref, a code {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
|
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
2
docs/build/html/_static/doctools.js
vendored
2
docs/build/html/_static/doctools.js
vendored
@ -301,12 +301,14 @@ var Documentation = {
|
||||
window.location.href = prevHref;
|
||||
return false;
|
||||
}
|
||||
break;
|
||||
case 39: // right
|
||||
var nextHref = $('link[rel="next"]').prop('href');
|
||||
if (nextHref) {
|
||||
window.location.href = nextHref;
|
||||
return false;
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
BIN
docs/build/html/_static/fonts/Inconsolata-Bold.ttf
vendored
BIN
docs/build/html/_static/fonts/Inconsolata-Bold.ttf
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/html/_static/fonts/Inconsolata.ttf
vendored
BIN
docs/build/html/_static/fonts/Inconsolata.ttf
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato-Bold.ttf
vendored
BIN
docs/build/html/_static/fonts/Lato-Bold.ttf
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato-Regular.ttf
vendored
BIN
docs/build/html/_static/fonts/Lato-Regular.ttf
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-bold.eot
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-bold.eot
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-bold.ttf
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-bold.ttf
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-bold.woff
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-bold.woff
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-bold.woff2
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-bold.woff2
vendored
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-italic.eot
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-italic.eot
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-italic.ttf
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-italic.ttf
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-italic.woff
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-italic.woff
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-italic.woff2
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-italic.woff2
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-regular.eot
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-regular.eot
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-regular.ttf
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-regular.ttf
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/Lato/lato-regular.woff
vendored
BIN
docs/build/html/_static/fonts/Lato/lato-regular.woff
vendored
Binary file not shown.
Binary file not shown.
BIN
docs/build/html/_static/fonts/RobotoSlab-Bold.ttf
vendored
BIN
docs/build/html/_static/fonts/RobotoSlab-Bold.ttf
vendored
Binary file not shown.
BIN
docs/build/html/_static/fonts/RobotoSlab-Regular.ttf
vendored
BIN
docs/build/html/_static/fonts/RobotoSlab-Regular.ttf
vendored
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
2671
docs/build/html/_static/fonts/fontawesome-webfont.svg
vendored
2671
docs/build/html/_static/fonts/fontawesome-webfont.svg
vendored
File diff suppressed because it is too large
Load Diff
Before Width: | Height: | Size: 434 KiB |
Binary file not shown.
Binary file not shown.
Binary file not shown.
4
docs/build/html/_static/js/modernizr.min.js
vendored
4
docs/build/html/_static/js/modernizr.min.js
vendored
File diff suppressed because one or more lines are too long
2
docs/build/html/_static/js/theme.js
vendored
2
docs/build/html/_static/js/theme.js
vendored
File diff suppressed because one or more lines are too long
10
docs/build/html/_static/searchtools.js
vendored
10
docs/build/html/_static/searchtools.js
vendored
@ -282,7 +282,10 @@ var Search = {
|
||||
complete: function(jqxhr, textstatus) {
|
||||
var data = jqxhr.responseText;
|
||||
if (data !== '' && data !== undefined) {
|
||||
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
|
||||
var summary = Search.makeSearchSummary(data, searchterms, hlterms);
|
||||
if (summary) {
|
||||
listItem.append(summary);
|
||||
}
|
||||
}
|
||||
Search.output.append(listItem);
|
||||
setTimeout(function() {
|
||||
@ -498,6 +501,9 @@ var Search = {
|
||||
*/
|
||||
makeSearchSummary : function(htmlText, keywords, hlwords) {
|
||||
var text = Search.htmlToText(htmlText);
|
||||
if (text == "") {
|
||||
return null;
|
||||
}
|
||||
var textLower = text.toLowerCase();
|
||||
var start = 0;
|
||||
$.each(keywords, function() {
|
||||
@ -509,7 +515,7 @@ var Search = {
|
||||
var excerpt = ((start > 0) ? '...' : '') +
|
||||
$.trim(text.substr(start, 240)) +
|
||||
((start + 240 - text.length) ? '...' : '');
|
||||
var rv = $('<div class="context"></div>').text(excerpt);
|
||||
var rv = $('<p class="context"></p>').text(excerpt);
|
||||
$.each(hlwords, function() {
|
||||
rv = rv.highlightText(this, 'highlighted');
|
||||
});
|
||||
|
@ -1,19 +1,19 @@
|
||||
(function (global, factory) {
|
||||
typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
|
||||
typeof define === 'function' && define.amd ? define('underscore', factory) :
|
||||
(global = global || self, (function () {
|
||||
(global = typeof globalThis !== 'undefined' ? globalThis : global || self, (function () {
|
||||
var current = global._;
|
||||
var exports = global._ = factory();
|
||||
exports.noConflict = function () { global._ = current; return exports; };
|
||||
}()));
|
||||
}(this, (function () {
|
||||
// Underscore.js 1.12.0
|
||||
// Underscore.js 1.13.1
|
||||
// https://underscorejs.org
|
||||
// (c) 2009-2020 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
|
||||
// (c) 2009-2021 Jeremy Ashkenas, Julian Gonggrijp, and DocumentCloud and Investigative Reporters & Editors
|
||||
// Underscore may be freely distributed under the MIT license.
|
||||
|
||||
// Current version.
|
||||
var VERSION = '1.12.0';
|
||||
var VERSION = '1.13.1';
|
||||
|
||||
// Establish the root object, `window` (`self`) in the browser, `global`
|
||||
// on the server, or `this` in some virtual machines. We use `self`
|
||||
@ -170,7 +170,7 @@
|
||||
var isArray = nativeIsArray || tagTester('Array');
|
||||
|
||||
// Internal function to check whether `key` is an own property name of `obj`.
|
||||
function has(obj, key) {
|
||||
function has$1(obj, key) {
|
||||
return obj != null && hasOwnProperty.call(obj, key);
|
||||
}
|
||||
|
||||
@ -181,7 +181,7 @@
|
||||
(function() {
|
||||
if (!isArguments(arguments)) {
|
||||
isArguments = function(obj) {
|
||||
return has(obj, 'callee');
|
||||
return has$1(obj, 'callee');
|
||||
};
|
||||
}
|
||||
}());
|
||||
@ -268,7 +268,7 @@
|
||||
|
||||
// Constructor is a special case.
|
||||
var prop = 'constructor';
|
||||
if (has(obj, prop) && !keys.contains(prop)) keys.push(prop);
|
||||
if (has$1(obj, prop) && !keys.contains(prop)) keys.push(prop);
|
||||
|
||||
while (nonEnumIdx--) {
|
||||
prop = nonEnumerableProps[nonEnumIdx];
|
||||
@ -284,7 +284,7 @@
|
||||
if (!isObject(obj)) return [];
|
||||
if (nativeKeys) return nativeKeys(obj);
|
||||
var keys = [];
|
||||
for (var key in obj) if (has(obj, key)) keys.push(key);
|
||||
for (var key in obj) if (has$1(obj, key)) keys.push(key);
|
||||
// Ahem, IE < 9.
|
||||
if (hasEnumBug) collectNonEnumProps(obj, keys);
|
||||
return keys;
|
||||
@ -318,24 +318,24 @@
|
||||
// If Underscore is called as a function, it returns a wrapped object that can
|
||||
// be used OO-style. This wrapper holds altered versions of all functions added
|
||||
// through `_.mixin`. Wrapped objects may be chained.
|
||||
function _(obj) {
|
||||
if (obj instanceof _) return obj;
|
||||
if (!(this instanceof _)) return new _(obj);
|
||||
function _$1(obj) {
|
||||
if (obj instanceof _$1) return obj;
|
||||
if (!(this instanceof _$1)) return new _$1(obj);
|
||||
this._wrapped = obj;
|
||||
}
|
||||
|
||||
_.VERSION = VERSION;
|
||||
_$1.VERSION = VERSION;
|
||||
|
||||
// Extracts the result from a wrapped and chained object.
|
||||
_.prototype.value = function() {
|
||||
_$1.prototype.value = function() {
|
||||
return this._wrapped;
|
||||
};
|
||||
|
||||
// Provide unwrapping proxies for some methods used in engine operations
|
||||
// such as arithmetic and JSON stringification.
|
||||
_.prototype.valueOf = _.prototype.toJSON = _.prototype.value;
|
||||
_$1.prototype.valueOf = _$1.prototype.toJSON = _$1.prototype.value;
|
||||
|
||||
_.prototype.toString = function() {
|
||||
_$1.prototype.toString = function() {
|
||||
return String(this._wrapped);
|
||||
};
|
||||
|
||||
@ -370,8 +370,8 @@
|
||||
// Internal recursive comparison function for `_.isEqual`.
|
||||
function deepEq(a, b, aStack, bStack) {
|
||||
// Unwrap any wrapped objects.
|
||||
if (a instanceof _) a = a._wrapped;
|
||||
if (b instanceof _) b = b._wrapped;
|
||||
if (a instanceof _$1) a = a._wrapped;
|
||||
if (b instanceof _$1) b = b._wrapped;
|
||||
// Compare `[[Class]]` names.
|
||||
var className = toString.call(a);
|
||||
if (className !== toString.call(b)) return false;
|
||||
@ -463,7 +463,7 @@
|
||||
while (length--) {
|
||||
// Deep compare each member
|
||||
key = _keys[length];
|
||||
if (!(has(b, key) && eq(a[key], b[key], aStack, bStack))) return false;
|
||||
if (!(has$1(b, key) && eq(a[key], b[key], aStack, bStack))) return false;
|
||||
}
|
||||
}
|
||||
// Remove the first object from the stack of traversed objects.
|
||||
@ -642,15 +642,15 @@
|
||||
|
||||
// Normalize a (deep) property `path` to array.
|
||||
// Like `_.iteratee`, this function can be customized.
|
||||
function toPath(path) {
|
||||
function toPath$1(path) {
|
||||
return isArray(path) ? path : [path];
|
||||
}
|
||||
_.toPath = toPath;
|
||||
_$1.toPath = toPath$1;
|
||||
|
||||
// Internal wrapper for `_.toPath` to enable minification.
|
||||
// Similar to `cb` for `_.iteratee`.
|
||||
function toPath$1(path) {
|
||||
return _.toPath(path);
|
||||
function toPath(path) {
|
||||
return _$1.toPath(path);
|
||||
}
|
||||
|
||||
// Internal function to obtain a nested property in `obj` along `path`.
|
||||
@ -668,19 +668,19 @@
|
||||
// `undefined`, return `defaultValue` instead.
|
||||
// The `path` is normalized through `_.toPath`.
|
||||
function get(object, path, defaultValue) {
|
||||
var value = deepGet(object, toPath$1(path));
|
||||
var value = deepGet(object, toPath(path));
|
||||
return isUndefined(value) ? defaultValue : value;
|
||||
}
|
||||
|
||||
// Shortcut function for checking if an object has a given property directly on
|
||||
// itself (in other words, not on a prototype). Unlike the internal `has`
|
||||
// function, this public version can also traverse nested properties.
|
||||
function has$1(obj, path) {
|
||||
path = toPath$1(path);
|
||||
function has(obj, path) {
|
||||
path = toPath(path);
|
||||
var length = path.length;
|
||||
for (var i = 0; i < length; i++) {
|
||||
var key = path[i];
|
||||
if (!has(obj, key)) return false;
|
||||
if (!has$1(obj, key)) return false;
|
||||
obj = obj[key];
|
||||
}
|
||||
return !!length;
|
||||
@ -703,7 +703,7 @@
|
||||
// Creates a function that, when passed an object, will traverse that object’s
|
||||
// properties down the given `path`, specified as an array of keys or indices.
|
||||
function property(path) {
|
||||
path = toPath$1(path);
|
||||
path = toPath(path);
|
||||
return function(obj) {
|
||||
return deepGet(obj, path);
|
||||
};
|
||||
@ -747,12 +747,12 @@
|
||||
function iteratee(value, context) {
|
||||
return baseIteratee(value, context, Infinity);
|
||||
}
|
||||
_.iteratee = iteratee;
|
||||
_$1.iteratee = iteratee;
|
||||
|
||||
// The function we call internally to generate a callback. It invokes
|
||||
// `_.iteratee` if overridden, otherwise `baseIteratee`.
|
||||
function cb(value, context, argCount) {
|
||||
if (_.iteratee !== iteratee) return _.iteratee(value, context);
|
||||
if (_$1.iteratee !== iteratee) return _$1.iteratee(value, context);
|
||||
return baseIteratee(value, context, argCount);
|
||||
}
|
||||
|
||||
@ -840,7 +840,7 @@
|
||||
|
||||
// By default, Underscore uses ERB-style template delimiters. Change the
|
||||
// following template settings to use alternative delimiters.
|
||||
var templateSettings = _.templateSettings = {
|
||||
var templateSettings = _$1.templateSettings = {
|
||||
evaluate: /<%([\s\S]+?)%>/g,
|
||||
interpolate: /<%=([\s\S]+?)%>/g,
|
||||
escape: /<%-([\s\S]+?)%>/g
|
||||
@ -868,13 +868,20 @@
|
||||
return '\\' + escapes[match];
|
||||
}
|
||||
|
||||
// In order to prevent third-party code injection through
|
||||
// `_.templateSettings.variable`, we test it against the following regular
|
||||
// expression. It is intentionally a bit more liberal than just matching valid
|
||||
// identifiers, but still prevents possible loopholes through defaults or
|
||||
// destructuring assignment.
|
||||
var bareIdentifier = /^\s*(\w|\$)+\s*$/;
|
||||
|
||||
// JavaScript micro-templating, similar to John Resig's implementation.
|
||||
// Underscore templating handles arbitrary delimiters, preserves whitespace,
|
||||
// and correctly escapes quotes within interpolated code.
|
||||
// NB: `oldSettings` only exists for backwards compatibility.
|
||||
function template(text, settings, oldSettings) {
|
||||
if (!settings && oldSettings) settings = oldSettings;
|
||||
settings = defaults({}, settings, _.templateSettings);
|
||||
settings = defaults({}, settings, _$1.templateSettings);
|
||||
|
||||
// Combine delimiters into one regular expression via alternation.
|
||||
var matcher = RegExp([
|
||||
@ -903,8 +910,17 @@
|
||||
});
|
||||
source += "';\n";
|
||||
|
||||
// If a variable is not specified, place data values in local scope.
|
||||
if (!settings.variable) source = 'with(obj||{}){\n' + source + '}\n';
|
||||
var argument = settings.variable;
|
||||
if (argument) {
|
||||
// Insure against third-party code injection. (CVE-2021-23358)
|
||||
if (!bareIdentifier.test(argument)) throw new Error(
|
||||
'variable is not a bare identifier: ' + argument
|
||||
);
|
||||
} else {
|
||||
// If a variable is not specified, place data values in local scope.
|
||||
source = 'with(obj||{}){\n' + source + '}\n';
|
||||
argument = 'obj';
|
||||
}
|
||||
|
||||
source = "var __t,__p='',__j=Array.prototype.join," +
|
||||
"print=function(){__p+=__j.call(arguments,'');};\n" +
|
||||
@ -912,18 +928,17 @@
|
||||
|
||||
var render;
|
||||
try {
|
||||
render = new Function(settings.variable || 'obj', '_', source);
|
||||
render = new Function(argument, '_', source);
|
||||
} catch (e) {
|
||||
e.source = source;
|
||||
throw e;
|
||||
}
|
||||
|
||||
var template = function(data) {
|
||||
return render.call(this, data, _);
|
||||
return render.call(this, data, _$1);
|
||||
};
|
||||
|
||||
// Provide the compiled source as a convenience for precompilation.
|
||||
var argument = settings.variable || 'obj';
|
||||
template.source = 'function(' + argument + '){\n' + source + '}';
|
||||
|
||||
return template;
|
||||
@ -933,7 +948,7 @@
|
||||
// is invoked with its parent as context. Returns the value of the final
|
||||
// child, or `fallback` if any child is undefined.
|
||||
function result(obj, path, fallback) {
|
||||
path = toPath$1(path);
|
||||
path = toPath(path);
|
||||
var length = path.length;
|
||||
if (!length) {
|
||||
return isFunction$1(fallback) ? fallback.call(obj) : fallback;
|
||||
@ -959,7 +974,7 @@
|
||||
|
||||
// Start chaining a wrapped Underscore object.
|
||||
function chain(obj) {
|
||||
var instance = _(obj);
|
||||
var instance = _$1(obj);
|
||||
instance._chain = true;
|
||||
return instance;
|
||||
}
|
||||
@ -993,7 +1008,7 @@
|
||||
return bound;
|
||||
});
|
||||
|
||||
partial.placeholder = _;
|
||||
partial.placeholder = _$1;
|
||||
|
||||
// Create a function bound to a given object (assigning `this`, and arguments,
|
||||
// optionally).
|
||||
@ -1012,7 +1027,7 @@
|
||||
var isArrayLike = createSizePropertyCheck(getLength);
|
||||
|
||||
// Internal implementation of a recursive `flatten` function.
|
||||
function flatten(input, depth, strict, output) {
|
||||
function flatten$1(input, depth, strict, output) {
|
||||
output = output || [];
|
||||
if (!depth && depth !== 0) {
|
||||
depth = Infinity;
|
||||
@ -1025,7 +1040,7 @@
|
||||
if (isArrayLike(value) && (isArray(value) || isArguments$1(value))) {
|
||||
// Flatten current level of array or arguments object.
|
||||
if (depth > 1) {
|
||||
flatten(value, depth - 1, strict, output);
|
||||
flatten$1(value, depth - 1, strict, output);
|
||||
idx = output.length;
|
||||
} else {
|
||||
var j = 0, len = value.length;
|
||||
@ -1042,7 +1057,7 @@
|
||||
// are the method names to be bound. Useful for ensuring that all callbacks
|
||||
// defined on an object belong to it.
|
||||
var bindAll = restArguments(function(obj, keys) {
|
||||
keys = flatten(keys, false, false);
|
||||
keys = flatten$1(keys, false, false);
|
||||
var index = keys.length;
|
||||
if (index < 1) throw new Error('bindAll must be passed function names');
|
||||
while (index--) {
|
||||
@ -1057,7 +1072,7 @@
|
||||
var memoize = function(key) {
|
||||
var cache = memoize.cache;
|
||||
var address = '' + (hasher ? hasher.apply(this, arguments) : key);
|
||||
if (!has(cache, address)) cache[address] = func.apply(this, arguments);
|
||||
if (!has$1(cache, address)) cache[address] = func.apply(this, arguments);
|
||||
return cache[address];
|
||||
};
|
||||
memoize.cache = {};
|
||||
@ -1074,7 +1089,7 @@
|
||||
|
||||
// Defers a function, scheduling it to run after the current call stack has
|
||||
// cleared.
|
||||
var defer = partial(delay, _, 1);
|
||||
var defer = partial(delay, _$1, 1);
|
||||
|
||||
// Returns a function, that, when invoked, will only be triggered at most once
|
||||
// during a given window of time. Normally, the throttled function will run
|
||||
@ -1420,7 +1435,7 @@
|
||||
if (isFunction$1(path)) {
|
||||
func = path;
|
||||
} else {
|
||||
path = toPath$1(path);
|
||||
path = toPath(path);
|
||||
contextPath = path.slice(0, -1);
|
||||
path = path[path.length - 1];
|
||||
}
|
||||
@ -1562,7 +1577,7 @@
|
||||
// Groups the object's values by a criterion. Pass either a string attribute
|
||||
// to group by, or a function that returns the criterion.
|
||||
var groupBy = group(function(result, value, key) {
|
||||
if (has(result, key)) result[key].push(value); else result[key] = [value];
|
||||
if (has$1(result, key)) result[key].push(value); else result[key] = [value];
|
||||
});
|
||||
|
||||
// Indexes the object's values by a criterion, similar to `_.groupBy`, but for
|
||||
@ -1575,7 +1590,7 @@
|
||||
// either a string attribute to count by, or a function that returns the
|
||||
// criterion.
|
||||
var countBy = group(function(result, value, key) {
|
||||
if (has(result, key)) result[key]++; else result[key] = 1;
|
||||
if (has$1(result, key)) result[key]++; else result[key] = 1;
|
||||
});
|
||||
|
||||
// Split a collection into two arrays: one whose elements all pass the given
|
||||
@ -1618,7 +1633,7 @@
|
||||
keys = allKeys(obj);
|
||||
} else {
|
||||
iteratee = keyInObj;
|
||||
keys = flatten(keys, false, false);
|
||||
keys = flatten$1(keys, false, false);
|
||||
obj = Object(obj);
|
||||
}
|
||||
for (var i = 0, length = keys.length; i < length; i++) {
|
||||
@ -1636,7 +1651,7 @@
|
||||
iteratee = negate(iteratee);
|
||||
if (keys.length > 1) context = keys[1];
|
||||
} else {
|
||||
keys = map(flatten(keys, false, false), String);
|
||||
keys = map(flatten$1(keys, false, false), String);
|
||||
iteratee = function(value, key) {
|
||||
return !contains(keys, key);
|
||||
};
|
||||
@ -1681,14 +1696,14 @@
|
||||
|
||||
// Flatten out an array, either recursively (by default), or up to `depth`.
|
||||
// Passing `true` or `false` as `depth` means `1` or `Infinity`, respectively.
|
||||
function flatten$1(array, depth) {
|
||||
return flatten(array, depth, false);
|
||||
function flatten(array, depth) {
|
||||
return flatten$1(array, depth, false);
|
||||
}
|
||||
|
||||
// Take the difference between one array and a number of other arrays.
|
||||
// Only the elements present in just the first array will remain.
|
||||
var difference = restArguments(function(array, rest) {
|
||||
rest = flatten(rest, true, true);
|
||||
rest = flatten$1(rest, true, true);
|
||||
return filter(array, function(value){
|
||||
return !contains(rest, value);
|
||||
});
|
||||
@ -1734,7 +1749,7 @@
|
||||
// Produce an array that contains the union: each distinct element from all of
|
||||
// the passed-in arrays.
|
||||
var union = restArguments(function(arrays) {
|
||||
return uniq(flatten(arrays, true, true));
|
||||
return uniq(flatten$1(arrays, true, true));
|
||||
});
|
||||
|
||||
// Produce an array that contains every item shared between all the
|
||||
@ -1821,26 +1836,26 @@
|
||||
|
||||
// Helper function to continue chaining intermediate results.
|
||||
function chainResult(instance, obj) {
|
||||
return instance._chain ? _(obj).chain() : obj;
|
||||
return instance._chain ? _$1(obj).chain() : obj;
|
||||
}
|
||||
|
||||
// Add your own custom functions to the Underscore object.
|
||||
function mixin(obj) {
|
||||
each(functions(obj), function(name) {
|
||||
var func = _[name] = obj[name];
|
||||
_.prototype[name] = function() {
|
||||
var func = _$1[name] = obj[name];
|
||||
_$1.prototype[name] = function() {
|
||||
var args = [this._wrapped];
|
||||
push.apply(args, arguments);
|
||||
return chainResult(this, func.apply(_, args));
|
||||
return chainResult(this, func.apply(_$1, args));
|
||||
};
|
||||
});
|
||||
return _;
|
||||
return _$1;
|
||||
}
|
||||
|
||||
// Add all mutator `Array` functions to the wrapper.
|
||||
each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
|
||||
var method = ArrayProto[name];
|
||||
_.prototype[name] = function() {
|
||||
_$1.prototype[name] = function() {
|
||||
var obj = this._wrapped;
|
||||
if (obj != null) {
|
||||
method.apply(obj, arguments);
|
||||
@ -1855,7 +1870,7 @@
|
||||
// Add all accessor `Array` functions to the wrapper.
|
||||
each(['concat', 'join', 'slice'], function(name) {
|
||||
var method = ArrayProto[name];
|
||||
_.prototype[name] = function() {
|
||||
_$1.prototype[name] = function() {
|
||||
var obj = this._wrapped;
|
||||
if (obj != null) obj = method.apply(obj, arguments);
|
||||
return chainResult(this, obj);
|
||||
@ -1909,12 +1924,12 @@
|
||||
clone: clone,
|
||||
tap: tap,
|
||||
get: get,
|
||||
has: has$1,
|
||||
has: has,
|
||||
mapObject: mapObject,
|
||||
identity: identity,
|
||||
constant: constant,
|
||||
noop: noop,
|
||||
toPath: toPath,
|
||||
toPath: toPath$1,
|
||||
property: property,
|
||||
propertyOf: propertyOf,
|
||||
matcher: matcher,
|
||||
@ -1997,7 +2012,7 @@
|
||||
tail: rest,
|
||||
drop: rest,
|
||||
compact: compact,
|
||||
flatten: flatten$1,
|
||||
flatten: flatten,
|
||||
without: without,
|
||||
uniq: uniq,
|
||||
unique: uniq,
|
||||
@ -2011,17 +2026,17 @@
|
||||
range: range,
|
||||
chunk: chunk,
|
||||
mixin: mixin,
|
||||
'default': _
|
||||
'default': _$1
|
||||
};
|
||||
|
||||
// Default Export
|
||||
|
||||
// Add all of the Underscore functions to the wrapper object.
|
||||
var _$1 = mixin(allExports);
|
||||
var _ = mixin(allExports);
|
||||
// Legacy Node.js API.
|
||||
_$1._ = _$1;
|
||||
_._ = _;
|
||||
|
||||
return _$1;
|
||||
return _;
|
||||
|
||||
})));
|
||||
//# sourceMappingURL=underscore.js.map
|
||||
//# sourceMappingURL=underscore-umd.js.map
|
8
docs/build/html/_static/underscore.js
vendored
8
docs/build/html/_static/underscore.js
vendored
File diff suppressed because one or more lines are too long
153
docs/build/html/cli.add.html
vendored
153
docs/build/html/cli.add.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>cpl add — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="cpl build" href="cli.build.html" />
|
||||
<link rel="prev" title="CLI Overview and Command Reference" href="cli.overview.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -112,77 +64,35 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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 class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cli.add.md.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="cpl-add">
|
||||
<h1>cpl add<a class="headerlink" href="#cpl-add" title="Permalink to this headline">¶</a></h1>
|
||||
|
||||
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-add">
|
||||
<h1>cpl add<a class="headerlink" href="#cpl-add" title="Permalink to this headline"></a></h1>
|
||||
<div class="section" id="contents">
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="#description">Description</a></p></li>
|
||||
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
|
||||
@ -193,12 +103,12 @@ cpl <strong>a</strong> <em><source-project></em> <em><target-project>
|
||||
cpl <strong>A</strong> <em><source-project></em> <em><target-project></em></p>
|
||||
</div>
|
||||
<div class="section" id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
|
||||
<p>Adds a project reference to given project.</p>
|
||||
<p>If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified.</p>
|
||||
</div>
|
||||
<div class="section" id="arguments">
|
||||
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
@ -222,50 +132,33 @@ cpl <strong>A</strong> <em><source-project></em> <em><target-project>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cli.build.html" class="btn btn-neutral float-right" title="cpl build" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cli.overview.html" class="btn btn-neutral float-left" title="CLI Overview and Command Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cli.build.html" class="btn btn-neutral float-right" title="cpl build" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
151
docs/build/html/cli.build.html
vendored
151
docs/build/html/cli.build.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>cpl build — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="cpl generate" href="cli.generate.html" />
|
||||
<link rel="prev" title="cpl add" href="cli.add.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -111,77 +63,35 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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 class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cli.build.md.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="cpl-build">
|
||||
<h1>cpl build<a class="headerlink" href="#cpl-build" title="Permalink to this headline">¶</a></h1>
|
||||
|
||||
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-build">
|
||||
<h1>cpl build<a class="headerlink" href="#cpl-build" title="Permalink to this headline"></a></h1>
|
||||
<div class="section" id="contents">
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="#description">Description</a></p></li>
|
||||
</ul>
|
||||
@ -192,7 +102,7 @@ cpl <strong>b</strong> <br>
|
||||
cpl <strong>B</strong></p>
|
||||
</div>
|
||||
<div class="section" id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
|
||||
<p>The command can be used to build a project of type “console” or “library”.</p>
|
||||
<p>The build command copies all included source files to the output directory. You can run the source files in the output directory directly.</p>
|
||||
<p>The command is used to prepare the source files for the publish command or to copy them to an target for execution.</p>
|
||||
@ -206,50 +116,33 @@ cpl <strong>B</strong></p>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cli.generate.html" class="btn btn-neutral float-right" title="cpl generate" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cli.add.html" class="btn btn-neutral float-left" title="cpl add" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cli.generate.html" class="btn btn-neutral float-right" title="cpl generate" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
155
docs/build/html/cli.generate.html
vendored
155
docs/build/html/cli.generate.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>cpl generate — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="cpl help" href="cli.help.html" />
|
||||
<link rel="prev" title="cpl build" href="cli.build.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -113,77 +65,35 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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 class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cli.generate.md.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="cpl-generate">
|
||||
<h1>cpl generate<a class="headerlink" href="#cpl-generate" title="Permalink to this headline">¶</a></h1>
|
||||
|
||||
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-generate">
|
||||
<h1>cpl generate<a class="headerlink" href="#cpl-generate" title="Permalink to this headline"></a></h1>
|
||||
<div class="section" id="contents">
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="#description">Description</a></p></li>
|
||||
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
|
||||
@ -195,11 +105,11 @@ cpl <strong>g</strong> <em><schematic></em> <em><name></em> <br>
|
||||
cpl <strong>G</strong> <em><schematic></em> <em><name></em></p>
|
||||
</div>
|
||||
<div class="section" id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
|
||||
<p>Generates files based on a schematic.</p>
|
||||
</div>
|
||||
<div class="section" id="arguments">
|
||||
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
@ -220,7 +130,7 @@ cpl <strong>G</strong> <em><schematic></em> <em><name></em></p>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="schematics">
|
||||
<h2>Schematics<a class="headerlink" href="#schematics" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Schematics<a class="headerlink" href="#schematics" title="Permalink to this headline"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Schematic</p></th>
|
||||
@ -260,50 +170,33 @@ cpl <strong>G</strong> <em><schematic></em> <em><name></em></p>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cli.help.html" class="btn btn-neutral float-right" title="cpl help" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cli.build.html" class="btn btn-neutral float-left" title="cpl build" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cli.help.html" class="btn btn-neutral float-right" title="cpl help" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
151
docs/build/html/cli.help.html
vendored
151
docs/build/html/cli.help.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>cpl help — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="cpl install" href="cli.install.html" />
|
||||
<link rel="prev" title="cpl generate" href="cli.generate.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -111,75 +63,33 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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 class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cli.help.md.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="cpl-help">
|
||||
<h1>cpl help<a class="headerlink" href="#cpl-help" title="Permalink to this headline">¶</a></h1>
|
||||
|
||||
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-help">
|
||||
<h1>cpl help<a class="headerlink" href="#cpl-help" title="Permalink to this headline"></a></h1>
|
||||
<!-- ## Contents
|
||||
|
||||
- [Description](#description) -->
|
||||
@ -189,11 +99,11 @@
|
||||
cpl <strong>h</strong> <em><command></em> <br>
|
||||
cpl <strong>H</strong> <em><command></em></p>
|
||||
<div class="section" id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
|
||||
<p>Lists available command and their short descriptions.</p>
|
||||
</div>
|
||||
<div class="section" id="arguments">
|
||||
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
@ -213,50 +123,33 @@ cpl <strong>H</strong> <em><command></em></p>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cli.install.html" class="btn btn-neutral float-right" title="cpl install" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cli.generate.html" class="btn btn-neutral float-left" title="cpl generate" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cli.install.html" class="btn btn-neutral float-right" title="cpl install" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
153
docs/build/html/cli.install.html
vendored
153
docs/build/html/cli.install.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>cpl install — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="cpl new" href="cli.new.html" />
|
||||
<link rel="prev" title="cpl help" href="cli.help.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -112,77 +64,35 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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 class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cli.install.md.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="cpl-install">
|
||||
<h1>cpl install<a class="headerlink" href="#cpl-install" title="Permalink to this headline">¶</a></h1>
|
||||
|
||||
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-install">
|
||||
<h1>cpl install<a class="headerlink" href="#cpl-install" title="Permalink to this headline"></a></h1>
|
||||
<div class="section" id="contents">
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="#description">Description</a></p></li>
|
||||
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
|
||||
@ -193,12 +103,12 @@ cpl <strong>i</strong> <em><package></em> <br>
|
||||
cpl <strong>I</strong> <em><package></em></p>
|
||||
</div>
|
||||
<div class="section" id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
|
||||
<p>Install given package to project via pip.
|
||||
Without given package it will install the depedencies of the CPL project your in.</p>
|
||||
</div>
|
||||
<div class="section" id="arguments">
|
||||
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
@ -218,50 +128,33 @@ Without given package it will install the depedencies of the CPL project your in
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cli.new.html" class="btn btn-neutral float-right" title="cpl new" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cli.help.html" class="btn btn-neutral float-left" title="cpl help" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cli.new.html" class="btn btn-neutral float-right" title="cpl new" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
153
docs/build/html/cli.new.html
vendored
153
docs/build/html/cli.new.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>cpl new — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="cpl publish" href="cli.publish.html" />
|
||||
<link rel="prev" title="cpl install" href="cli.install.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -112,77 +64,35 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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 class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cli.new.md.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="cpl-new">
|
||||
<h1>cpl new<a class="headerlink" href="#cpl-new" title="Permalink to this headline">¶</a></h1>
|
||||
|
||||
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-new">
|
||||
<h1>cpl new<a class="headerlink" href="#cpl-new" title="Permalink to this headline"></a></h1>
|
||||
<div class="section" id="contents">
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="#description">Description</a></p></li>
|
||||
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
|
||||
@ -194,7 +104,7 @@ cpl <strong>n</strong> <em><type></em> <em><name></em> <br>
|
||||
cpl <strong>N</strong> <em><type></em> <em><name></em></p>
|
||||
</div>
|
||||
<div class="section" id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
|
||||
<p>Generates a workspace and initial project or add a project to workspace.</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">
|
||||
@ -217,7 +127,7 @@ cpl <strong>N</strong> <em><type></em> <em><name></em></p>
|
||||
</table>
|
||||
</div>
|
||||
<div class="section" id="project-types">
|
||||
<h2>Project types<a class="headerlink" href="#project-types" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Project types<a class="headerlink" href="#project-types" title="Permalink to this headline"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Project type</p></th>
|
||||
@ -238,50 +148,33 @@ cpl <strong>N</strong> <em><type></em> <em><name></em></p>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cli.publish.html" class="btn btn-neutral float-right" title="cpl publish" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cli.install.html" class="btn btn-neutral float-left" title="cpl install" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cli.publish.html" class="btn btn-neutral float-right" title="cpl publish" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
159
docs/build/html/cli.overview.html
vendored
159
docs/build/html/cli.overview.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>CLI Overview and Command Reference — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="cpl add" href="cli.add.html" />
|
||||
<link rel="prev" title="CLI Reference" href="cpl_cli.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -117,77 +69,35 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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 class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cli.overview.md.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="cli-overview-and-command-reference">
|
||||
<h1>CLI Overview and Command Reference<a class="headerlink" href="#cli-overview-and-command-reference" title="Permalink to this headline">¶</a></h1>
|
||||
|
||||
<div class="tex2jax_ignore mathjax_ignore section" id="cli-overview-and-command-reference">
|
||||
<h1>CLI Overview and Command Reference<a class="headerlink" href="#cli-overview-and-command-reference" title="Permalink to this headline"></a></h1>
|
||||
<div class="section" id="table-of-contents">
|
||||
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline"></a></h2>
|
||||
<ol class="simple">
|
||||
<li><p><a class="reference external" href="setup#install-the-package">Install CPL</a></p></li>
|
||||
<li><p><a class="reference external" href="setup#install-the-cli">Install CPL CLI</a></p></li>
|
||||
@ -197,7 +107,7 @@
|
||||
</ol>
|
||||
</div>
|
||||
<div class="section" id="basic-workflow">
|
||||
<h2>Basic workflow<a class="headerlink" href="#basic-workflow" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Basic workflow<a class="headerlink" href="#basic-workflow" title="Permalink to this headline"></a></h2>
|
||||
<p>To create, build, and serve a new, basic CPL project on a development server, go to the parent directory of your new workspace use the following commands:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl new console my-first-project
|
||||
<span class="nb">cd</span> my-first-project
|
||||
@ -207,23 +117,23 @@ cpl start
|
||||
<p>In the terminal you will the output of the app.</p>
|
||||
</div>
|
||||
<div class="section" id="cli-command-language-syntax">
|
||||
<h2>CLI command-language syntax<a class="headerlink" href="#cli-command-language-syntax" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>CLI command-language syntax<a class="headerlink" href="#cli-command-language-syntax" title="Permalink to this headline"></a></h2>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">cpl</span></code> commandNameOrAlias requiredArg <code class="docutils literal notranslate"><span class="pre">[optionalsArgs]</span></code></p>
|
||||
<ul class="simple">
|
||||
<li><p>Most commands, and some options, have aliases. Aliases are shown in the syntax statement for each command.</p></li>
|
||||
<li><p>Arguments are not prefixed.</p></li>
|
||||
</ul>
|
||||
<div class="section" id="relative-paths">
|
||||
<h3>Relative paths<a class="headerlink" href="#relative-paths" title="Permalink to this headline">¶</a></h3>
|
||||
<h3>Relative paths<a class="headerlink" href="#relative-paths" title="Permalink to this headline"></a></h3>
|
||||
<p>Options that specify files can be given as absolute paths, or as paths relative to the current working directory, which is generally either the workspace or project root.</p>
|
||||
</div>
|
||||
<div class="section" id="schematics">
|
||||
<h3>Schematics<a class="headerlink" href="#schematics" title="Permalink to this headline">¶</a></h3>
|
||||
<h3>Schematics<a class="headerlink" href="#schematics" title="Permalink to this headline"></a></h3>
|
||||
<p>The cpl generate command takes as an argument the artifact to be generated. In addition to any general options, each artifact defines its own options in a schematic. Schematic options are supplied to the command in the same format as immediate command options.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="command-overview">
|
||||
<h2>Command overview<a class="headerlink" href="#command-overview" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Command overview<a class="headerlink" href="#command-overview" title="Permalink to this headline"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Command</p></th>
|
||||
@ -287,50 +197,33 @@ cpl start
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cli.add.html" class="btn btn-neutral float-right" title="cpl add" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_cli.html" class="btn btn-neutral float-left" title="CLI Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cli.add.html" class="btn btn-neutral float-right" title="cpl add" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
151
docs/build/html/cli.publish.html
vendored
151
docs/build/html/cli.publish.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>cpl publish — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="cpl remove" href="cli.remove.html" />
|
||||
<link rel="prev" title="cpl new" href="cli.new.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -111,77 +63,35 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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 class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cli.publish.md.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="cpl-publish">
|
||||
<h1>cpl publish<a class="headerlink" href="#cpl-publish" title="Permalink to this headline">¶</a></h1>
|
||||
|
||||
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-publish">
|
||||
<h1>cpl publish<a class="headerlink" href="#cpl-publish" title="Permalink to this headline"></a></h1>
|
||||
<div class="section" id="contents">
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="#description">Description</a></p></li>
|
||||
</ul>
|
||||
@ -192,7 +102,7 @@ cpl <strong>p</strong> <br>
|
||||
cpl <strong>P</strong></p>
|
||||
</div>
|
||||
<div class="section" id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
|
||||
<p>The command can be used to publish a project of type “console” or “library”.</p>
|
||||
<p>The publish command builds the source files and then creates an <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> with data from <code class="docutils literal notranslate"><span class="pre">cpl_core.json</span></code>.
|
||||
The command executes the <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> and removes all source files with the <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> from the ‘publish/’ directory.</p>
|
||||
@ -206,50 +116,33 @@ The command executes the <code class="docutils literal notranslate"><span class=
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cli.remove.html" class="btn btn-neutral float-right" title="cpl remove" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cli.new.html" class="btn btn-neutral float-left" title="cpl new" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cli.remove.html" class="btn btn-neutral float-right" title="cpl remove" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
153
docs/build/html/cli.remove.html
vendored
153
docs/build/html/cli.remove.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>cpl remove — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="cpl start" href="cli.start.html" />
|
||||
<link rel="prev" title="cpl publish" href="cli.publish.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -112,77 +64,35 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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 class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cli.remove.md.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="cpl-remove">
|
||||
<h1>cpl remove<a class="headerlink" href="#cpl-remove" title="Permalink to this headline">¶</a></h1>
|
||||
|
||||
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-remove">
|
||||
<h1>cpl remove<a class="headerlink" href="#cpl-remove" title="Permalink to this headline"></a></h1>
|
||||
<div class="section" id="contents">
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="#description">Description</a></p></li>
|
||||
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
|
||||
@ -193,12 +103,12 @@ cpl <strong>r</strong> <em><project></em> <br>
|
||||
cpl <strong>R</strong> <em><project></em></p>
|
||||
</div>
|
||||
<div class="section" id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
|
||||
<p>Removes a project reference and the files from workspace.</p>
|
||||
<p>If you call the command in a CPL workspace, you can use the project names. Otherwise the paths of the projects must be specified.</p>
|
||||
</div>
|
||||
<div class="section" id="arguments">
|
||||
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
@ -218,50 +128,33 @@ cpl <strong>R</strong> <em><project></em></p>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cli.start.html" class="btn btn-neutral float-right" title="cpl start" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cli.publish.html" class="btn btn-neutral float-left" title="cpl publish" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cli.start.html" class="btn btn-neutral float-right" title="cpl start" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
147
docs/build/html/cli.start.html
vendored
147
docs/build/html/cli.start.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>cpl start — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="cpl uninstall" href="cli.uninstall.html" />
|
||||
<link rel="prev" title="cpl remove" href="cli.remove.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -107,75 +59,33 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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 class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cli.start.md.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="cpl-start">
|
||||
<h1>cpl start<a class="headerlink" href="#cpl-start" title="Permalink to this headline">¶</a></h1>
|
||||
|
||||
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-start">
|
||||
<h1>cpl start<a class="headerlink" href="#cpl-start" title="Permalink to this headline"></a></h1>
|
||||
<p>Starts your application, restarting on file changes.</p>
|
||||
<p>cpl <strong>start</strong> <br>
|
||||
cpl <strong>s</strong> <br>
|
||||
@ -184,50 +94,33 @@ cpl <strong>S</strong></p>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cli.uninstall.html" class="btn btn-neutral float-right" title="cpl uninstall" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cli.remove.html" class="btn btn-neutral float-left" title="cpl remove" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cli.uninstall.html" class="btn btn-neutral float-right" title="cpl uninstall" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
153
docs/build/html/cli.uninstall.html
vendored
153
docs/build/html/cli.uninstall.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>cpl uninstall — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="cpl update" href="cli.update.html" />
|
||||
<link rel="prev" title="cpl start" href="cli.start.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -112,77 +64,35 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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 class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cli.uninstall.md.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="cpl-uninstall">
|
||||
<h1>cpl uninstall<a class="headerlink" href="#cpl-uninstall" title="Permalink to this headline">¶</a></h1>
|
||||
|
||||
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-uninstall">
|
||||
<h1>cpl uninstall<a class="headerlink" href="#cpl-uninstall" title="Permalink to this headline"></a></h1>
|
||||
<div class="section" id="contents">
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="#description">Description</a></p></li>
|
||||
<li><p><a class="reference external" href="#arguments">Arguments</a></p></li>
|
||||
@ -193,11 +103,11 @@ cpl <strong>ui</strong> <em><package></em> <br>
|
||||
cpl <strong>UI</strong> <em><package></em></p>
|
||||
</div>
|
||||
<div class="section" id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
|
||||
<p>Uninstall given package from project via pip.</p>
|
||||
</div>
|
||||
<div class="section" id="arguments">
|
||||
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline"></a></h2>
|
||||
<table class="colwidths-auto docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||
@ -217,50 +127,33 @@ cpl <strong>UI</strong> <em><package></em></p>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cli.update.html" class="btn btn-neutral float-right" title="cpl update" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cli.start.html" class="btn btn-neutral float-left" title="cpl start" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cli.update.html" class="btn btn-neutral float-right" title="cpl update" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
147
docs/build/html/cli.update.html
vendored
147
docs/build/html/cli.update.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>cpl update — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="cpl version" href="cli.version.html" />
|
||||
<link rel="prev" title="cpl uninstall" href="cli.uninstall.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -107,75 +59,33 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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 class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cli.update.md.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="cpl-update">
|
||||
<h1>cpl update<a class="headerlink" href="#cpl-update" title="Permalink to this headline">¶</a></h1>
|
||||
|
||||
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-update">
|
||||
<h1>cpl update<a class="headerlink" href="#cpl-update" title="Permalink to this headline"></a></h1>
|
||||
<p>Updates the CPL and project dependencies.</p>
|
||||
<p>cpl <strong>update</strong> <br>
|
||||
cpl <strong>u</strong> <br>
|
||||
@ -184,50 +94,33 @@ cpl <strong>U</strong></p>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cli.version.html" class="btn btn-neutral float-right" title="cpl version" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cli.uninstall.html" class="btn btn-neutral float-left" title="cpl uninstall" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cli.version.html" class="btn btn-neutral float-right" title="cpl version" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
147
docs/build/html/cli.version.html
vendored
147
docs/build/html/cli.version.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>cpl version — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="API Reference" href="cpl_core.html" />
|
||||
<link rel="prev" title="cpl update" href="cli.update.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -107,75 +59,33 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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 class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cli.version.md.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="cpl-version">
|
||||
<h1>cpl version<a class="headerlink" href="#cpl-version" title="Permalink to this headline">¶</a></h1>
|
||||
|
||||
<div class="tex2jax_ignore mathjax_ignore section" id="cpl-version">
|
||||
<h1>cpl version<a class="headerlink" href="#cpl-version" title="Permalink to this headline"></a></h1>
|
||||
<p>Lists the version of CPL, CPL CLI and all installed packages from pip.</p>
|
||||
<p>cpl <strong>version</strong> <br>
|
||||
cpl <strong>v</strong> <br>
|
||||
@ -184,50 +94,33 @@ cpl <strong>V</strong></p>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cpl_core.html" class="btn btn-neutral float-right" title="API Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cli.update.html" class="btn btn-neutral float-left" title="cpl update" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_core.html" class="btn btn-neutral float-right" title="API Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
159
docs/build/html/contributing.html
vendored
159
docs/build/html/contributing.html
vendored
@ -1,68 +1,31 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>Contributing to CPL — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -70,18 +33,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -90,73 +42,32 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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 class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/contributing.md.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="contributing-to-cpl">
|
||||
<h1>Contributing to CPL<a class="headerlink" href="#contributing-to-cpl" title="Permalink to this headline">¶</a></h1>
|
||||
|
||||
<div class="tex2jax_ignore mathjax_ignore section" id="contributing-to-cpl">
|
||||
<h1>Contributing to CPL<a class="headerlink" href="#contributing-to-cpl" title="Permalink to this headline"></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><a class="reference external" href="#found-a-bug">Issuses and Bugs</a></p></li>
|
||||
@ -166,20 +77,20 @@
|
||||
<li><p><a class="reference external" href="#license">License</a></p></li>
|
||||
</ul>
|
||||
<div class="section" id="found-a-bug">
|
||||
<h2>Found a Bug?<a class="headerlink" href="#found-a-bug" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Found a Bug?<a class="headerlink" href="#found-a-bug" title="Permalink to this headline"></a></h2>
|
||||
<p>If you find a bug in the source code, you can help us by <a class="reference external" href="#submitting-an-issue">submitting an issue</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 external" href="#submitting-a-pull-request">submit a Pull Request</a> with a fix.</p>
|
||||
</div>
|
||||
<div class="section" id="feature-request">
|
||||
<h2>Feature Request<a class="headerlink" href="#feature-request" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Feature Request<a class="headerlink" href="#feature-request" title="Permalink to this headline"></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 <a class="reference external" href="#submit-pr">Pull Request</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="submission-guidelines">
|
||||
<h2>Submission Guidelines<a class="headerlink" href="#submission-guidelines" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Submission Guidelines<a class="headerlink" href="#submission-guidelines" title="Permalink to this headline"></a></h2>
|
||||
<div class="section" id="submitting-an-issue">
|
||||
<h3>Submitting an Issue<a class="headerlink" href="#submitting-an-issue" title="Permalink to this headline">¶</a></h3>
|
||||
<h3>Submitting an Issue<a class="headerlink" href="#submitting-an-issue" title="Permalink to this headline"></a></h3>
|
||||
<p>Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.</p>
|
||||
<p>We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions.</p>
|
||||
<p>A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.</p>
|
||||
@ -187,7 +98,7 @@
|
||||
<p>Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don’t hear back from you, we are going to close an issue that doesn’t have enough info to be reproduced.</p>
|
||||
</div>
|
||||
<div class="section" id="submitting-a-pull-request">
|
||||
<h3>Submitting a Pull Request<a class="headerlink" href="#submitting-a-pull-request" title="Permalink to this headline">¶</a></h3>
|
||||
<h3>Submitting a Pull Request<a class="headerlink" href="#submitting-a-pull-request" title="Permalink to this headline"></a></h3>
|
||||
<p>Before you submit your Pull Request (PR) consider the following guidelines:</p>
|
||||
<ol>
|
||||
<li><p>Search the <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">repository</a> for an open or closed PR that relates to your submission. You don’t want to duplicate existing efforts.</p></li>
|
||||
@ -217,10 +128,10 @@
|
||||
</ol>
|
||||
</div>
|
||||
<div class="section" id="reviewing-a-pull-request">
|
||||
<h3>Reviewing a Pull Request<a class="headerlink" href="#reviewing-a-pull-request" title="Permalink to this headline">¶</a></h3>
|
||||
<h3>Reviewing a Pull Request<a class="headerlink" href="#reviewing-a-pull-request" title="Permalink to this headline"></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 <a class="reference external" href="#coding-rules">coding rules</a> and applies within or outside of CPL managed channels.</p>
|
||||
<div class="section" id="addressing-review-feedback">
|
||||
<h4>Addressing review feedback<a class="headerlink" href="#addressing-review-feedback" title="Permalink to this headline">¶</a></h4>
|
||||
<h4>Addressing review feedback<a class="headerlink" href="#addressing-review-feedback" title="Permalink to this headline"></a></h4>
|
||||
<p>If we ask for changes via code reviews then:</p>
|
||||
<ol>
|
||||
<li><p>Make the required updates to the code.</p></li>
|
||||
@ -236,7 +147,7 @@ git push
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="coding-rules">
|
||||
<h2>Coding Rules<a class="headerlink" href="#coding-rules" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Coding Rules<a class="headerlink" href="#coding-rules" title="Permalink to this headline"></a></h2>
|
||||
<p>To ensure consistency throughout the source code, keep these rules in mind as you are working:</p>
|
||||
<ul class="simple">
|
||||
<li><p>All features or bug fixes must be tested by one or more unit-tests.</p></li>
|
||||
@ -245,7 +156,7 @@ git push
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="license">
|
||||
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline"></a></h2>
|
||||
<p>By contributing, you agree that your contributions will be licensed under its MIT License.
|
||||
See <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/src/branch/master/LICENSE">LICENSE</a></p>
|
||||
<!-- LINKS -->
|
||||
@ -254,46 +165,30 @@ See <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
144
docs/build/html/cpl_cli.html
vendored
144
docs/build/html/cpl_cli.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>CLI Reference — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="cli.overview.html" />
|
||||
<link rel="prev" title="Setting up the local environment and workspace" href="setup.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -107,73 +59,32 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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 class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cpl_cli.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
|
||||
<div class="section" id="cli-reference">
|
||||
<h1>CLI Reference<a class="headerlink" href="#cli-reference" title="Permalink to this headline">¶</a></h1>
|
||||
<h1>CLI Reference<a class="headerlink" href="#cli-reference" title="Permalink to this headline"></a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a><ul>
|
||||
@ -248,50 +159,33 @@
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cli.overview.html" class="btn btn-neutral float-right" title="CLI Overview and Command Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="setup.html" class="btn btn-neutral float-left" title="Setting up the local environment and workspace" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cli.overview.html" class="btn btn-neutral float-right" title="CLI Overview and Command Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
209
docs/build/html/cpl_core.application.html
vendored
209
docs/build/html/cpl_core.application.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>cpl_core.application — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="cpl_core.configuration" href="cpl_core.configuration.html" />
|
||||
<link rel="prev" title="API Reference" href="cpl_core.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -110,80 +62,38 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cpl_core.application.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
|
||||
<div class="section" id="cpl-core-application">
|
||||
<h1>cpl_core.application<a class="headerlink" href="#cpl-core-application" title="Permalink to this headline">¶</a></h1>
|
||||
<h1>cpl_core.application<a class="headerlink" href="#cpl-core-application" title="Permalink to this headline"></a></h1>
|
||||
<div class="section" id="module-cpl_core.application.application_abc">
|
||||
<span id="cpl-core-application-application-abc"></span><h2>cpl_core.application.application_abc<a class="headerlink" href="#module-cpl_core.application.application_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-application-application-abc"></span><h2>cpl_core.application.application_abc<a class="headerlink" href="#module-cpl_core.application.application_abc" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.application.application_abc.ApplicationABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.application.application_abc.</span></code><code class="sig-name descname"><span class="pre">ApplicationABC</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_abc.ApplicationABC">
|
||||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.application_abc.</span></span><span class="sig-name descname"><span class="pre">ApplicationABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
|
||||
<p>ABC for the Application class</p>
|
||||
<blockquote>
|
||||
@ -195,22 +105,22 @@
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.application.application_abc.ApplicationABC.configure">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">configure</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.configure" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_abc.ApplicationABC.configure">
|
||||
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">configure</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.configure" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Configure the application</p>
|
||||
<p>Called by <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC.run" title="cpl_core.application.application_abc.ApplicationABC.run"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC.run</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.application.application_abc.ApplicationABC.main">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">main</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.main" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_abc.ApplicationABC.main">
|
||||
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.main" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Custom entry point</p>
|
||||
<p>Called by <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC.run" title="cpl_core.application.application_abc.ApplicationABC.run"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC.run</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.application.application_abc.ApplicationABC.run">
|
||||
<code class="sig-name descname"><span class="pre">run</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.run" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_abc.ApplicationABC.run">
|
||||
<span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_abc.ApplicationABC.run" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Entry point</p>
|
||||
<p>Called by custom Application.main</p>
|
||||
</dd></dl>
|
||||
@ -219,10 +129,10 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_core.application.application_builder">
|
||||
<span id="cpl-core-application-application-builder"></span><h2>cpl_core.application.application_builder<a class="headerlink" href="#module-cpl_core.application.application_builder" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-application-application-builder"></span><h2>cpl_core.application.application_builder<a class="headerlink" href="#module-cpl_core.application.application_builder" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.application.application_builder.ApplicationBuilder">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.application.application_builder.</span></code><code class="sig-name descname"><span class="pre">ApplicationBuilder</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder">
|
||||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.application_builder.</span></span><span class="sig-name descname"><span class="pre">ApplicationBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC" title="cpl_core.application.application_builder_abc.ApplicationBuilderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_builder_abc.ApplicationBuilderABC</span></code></a></p>
|
||||
<p>This is class is used to build a object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p>
|
||||
<blockquote>
|
||||
@ -232,8 +142,8 @@
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.application.application_builder.ApplicationBuilder.build">
|
||||
<code class="sig-name descname"><span class="pre">build</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.build" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.build">
|
||||
<span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.build" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates custom application object</p>
|
||||
<blockquote>
|
||||
<div><p>Object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p>
|
||||
@ -241,13 +151,13 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.application.application_builder.ApplicationBuilder.use_extension">
|
||||
<code class="sig-name descname"><span class="pre">use_extension</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extension</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">cpl_core.application.application_extension_abc.ApplicationExtensionABC</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_extension" title="Permalink to this definition">¶</a></dt>
|
||||
<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="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">cpl_core.application.application_extension_abc.ApplicationExtensionABC</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_extension" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.application.application_builder.ApplicationBuilder.use_startup">
|
||||
<code class="sig-name descname"><span class="pre">use_startup</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">startup</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><span class="pre">cpl_core.application.startup_abc.StartupABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_startup" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.use_startup">
|
||||
<span class="sig-name descname"><span class="pre">use_startup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">startup</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><span class="pre">cpl_core.application.startup_abc.StartupABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_startup" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets the custom startup class to use</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -261,15 +171,15 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_core.application.application_builder_abc">
|
||||
<span id="cpl-core-application-application-builder-abc"></span><h2>cpl_core.application.application_builder_abc<a class="headerlink" href="#module-cpl_core.application.application_builder_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-application-application-builder-abc"></span><h2>cpl_core.application.application_builder_abc<a class="headerlink" href="#module-cpl_core.application.application_builder_abc" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.application.application_builder_abc.ApplicationBuilderABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.application.application_builder_abc.</span></code><code class="sig-name descname"><span class="pre">ApplicationBuilderABC</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder_abc.ApplicationBuilderABC">
|
||||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.application_builder_abc.</span></span><span class="sig-name descname"><span class="pre">ApplicationBuilderABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
|
||||
<p>ABC for the <a class="reference internal" href="#cpl_core.application.application_builder.ApplicationBuilder" title="cpl_core.application.application_builder.ApplicationBuilder"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_builder.ApplicationBuilder</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.build">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">build</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC.build" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.build">
|
||||
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC.build" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates custom application object</p>
|
||||
<blockquote>
|
||||
<div><p>Object of <a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.application.application_abc.ApplicationABC</span></code></a></p>
|
||||
@ -277,8 +187,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.use_startup">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">use_startup</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">startup</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><span class="pre">cpl_core.application.startup_abc.StartupABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC.use_startup" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder_abc.ApplicationBuilderABC.use_startup">
|
||||
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">use_startup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">startup</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><span class="pre">cpl_core.application.startup_abc.StartupABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC.use_startup" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets the custom startup class to use</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -292,15 +202,15 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_core.application.startup_abc">
|
||||
<span id="cpl-core-application-startup-abc"></span><h2>cpl_core.application.startup_abc<a class="headerlink" href="#module-cpl_core.application.startup_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-application-startup-abc"></span><h2>cpl_core.application.startup_abc<a class="headerlink" href="#module-cpl_core.application.startup_abc" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.application.startup_abc.StartupABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.application.startup_abc.</span></code><code class="sig-name descname"><span class="pre">StartupABC</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.application.startup_abc.StartupABC">
|
||||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.startup_abc.</span></span><span class="sig-name descname"><span class="pre">StartupABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
|
||||
<p>ABC for the startup class</p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.application.startup_abc.StartupABC.configure_configuration">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">configure_configuration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC.configure_configuration" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.application.startup_abc.StartupABC.configure_configuration">
|
||||
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">configure_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a></span></span><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC.configure_configuration" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates configuration of application</p>
|
||||
<blockquote>
|
||||
<div><p>config: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></code></a>
|
||||
@ -312,8 +222,8 @@ env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_co
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.application.startup_abc.StartupABC.configure_services">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">configure_services</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></a><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC.configure_services" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.application.startup_abc.StartupABC.configure_services">
|
||||
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">configure_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></a></span></span><a class="headerlink" href="#cpl_core.application.startup_abc.StartupABC.configure_services" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates service provider</p>
|
||||
<blockquote>
|
||||
<div><p>services: <a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_collection_abc" title="cpl_core.dependency_injection.service_collection_abc"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection_abc</span></code></a>
|
||||
@ -331,50 +241,33 @@ env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_co
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cpl_core.configuration.html" class="btn btn-neutral float-right" title="cpl_core.configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_core.html" class="btn btn-neutral float-left" title="API Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_core.configuration.html" class="btn btn-neutral float-right" title="cpl_core.configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
331
docs/build/html/cpl_core.configuration.html
vendored
331
docs/build/html/cpl_core.configuration.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>cpl_core.configuration — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="cpl_core.console" href="cpl_core.console.html" />
|
||||
<link rel="prev" title="cpl_core.application" href="cpl_core.application.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -111,84 +63,42 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cpl_core.configuration.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
|
||||
<div class="section" id="cpl-core-configuration">
|
||||
<h1>cpl_core.configuration<a class="headerlink" href="#cpl-core-configuration" title="Permalink to this headline">¶</a></h1>
|
||||
<h1>cpl_core.configuration<a class="headerlink" href="#cpl-core-configuration" title="Permalink to this headline"></a></h1>
|
||||
<div class="section" id="module-cpl_core.configuration.configuration">
|
||||
<span id="cpl-core-configuration-configuration"></span><h2>cpl_core.configuration.configuration<a class="headerlink" href="#module-cpl_core.configuration.configuration" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-configuration-configuration"></span><h2>cpl_core.configuration.configuration<a class="headerlink" href="#module-cpl_core.configuration.configuration" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.configuration.configuration.Configuration">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration.</span></code><code class="sig-name descname"><span class="pre">Configuration</span></code><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration">
|
||||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration.</span></span><span class="sig-name descname"><span class="pre">Configuration</span></span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration.Configuration.add_configuration">
|
||||
<code class="sig-name descname"><span class="pre">add_configuration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_configuration" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.add_configuration">
|
||||
<span class="sig-name descname"><span class="pre">add_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_configuration" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Add configuration object</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -201,8 +111,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration.Configuration.add_console_argument">
|
||||
<code class="sig-name descname"><span class="pre">add_console_argument</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argument</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_core.configuration.console_argument.ConsoleArgument" title="cpl_core.configuration.console_argument.ConsoleArgument"><span class="pre">cpl_core.configuration.console_argument.ConsoleArgument</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_console_argument" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.add_console_argument">
|
||||
<span class="sig-name descname"><span class="pre">add_console_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argument</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_core.configuration.console_argument.ConsoleArgument" title="cpl_core.configuration.console_argument.ConsoleArgument"><span class="pre">cpl_core.configuration.console_argument.ConsoleArgument</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_console_argument" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds console argument to known console arguments</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -213,8 +123,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration.Configuration.add_console_arguments">
|
||||
<code class="sig-name descname"><span class="pre">add_console_arguments</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_console_arguments" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.add_console_arguments">
|
||||
<span class="sig-name descname"><span class="pre">add_console_arguments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_console_arguments" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Reads the console arguments</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -225,8 +135,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration.Configuration.add_environment_variables">
|
||||
<code class="sig-name descname"><span class="pre">add_environment_variables</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_environment_variables" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.add_environment_variables">
|
||||
<span class="sig-name descname"><span class="pre">add_environment_variables</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_environment_variables" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Reads the environment variables</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -237,8 +147,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration.Configuration.add_json_file">
|
||||
<code class="sig-name descname"><span class="pre">add_json_file</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_json_file" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.add_json_file">
|
||||
<span class="sig-name descname"><span class="pre">add_json_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_json_file" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Reads and saves settings from given json file</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -254,24 +164,24 @@
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration.Configuration.additional_arguments">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">additional_arguments</span></code><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.additional_arguments" title="Permalink to this definition">¶</a></dt>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.additional_arguments">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">additional_arguments</span></span><em class="property"><span class="pre">:</span> <span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.additional_arguments" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.argument_error_function">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">argument_error_function</span></span><em class="property"><span class="pre">:</span> <span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.argument_error_function" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.environment">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">environment</span></span><em class="property"><span class="pre">:</span> <a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></em><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.environment" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration.Configuration.argument_error_function">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">argument_error_function</span></code><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.argument_error_function" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration.Configuration.environment">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">environment</span></code><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.environment" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration.Configuration.get_configuration">
|
||||
<code class="sig-name descname"><span class="pre">get_configuration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> → <span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.get_configuration" title="Permalink to this definition">¶</a></dt>
|
||||
<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="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="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><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></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>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -288,14 +198,14 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_core.configuration.configuration_abc">
|
||||
<span id="cpl-core-configuration-configuration-abc"></span><h2>cpl_core.configuration.configuration_abc<a class="headerlink" href="#module-cpl_core.configuration.configuration_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-configuration-configuration-abc"></span><h2>cpl_core.configuration.configuration_abc<a class="headerlink" href="#module-cpl_core.configuration.configuration_abc" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_abc.</span></code><code class="sig-name descname"><span class="pre">ConfigurationABC</span></code><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC">
|
||||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_abc.</span></span><span class="sig-name descname"><span class="pre">ConfigurationABC</span></span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_configuration">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_configuration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_configuration" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_configuration">
|
||||
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">add_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_configuration" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Add configuration object</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -308,8 +218,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_argument">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_console_argument</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argument</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_core.configuration.console_argument.ConsoleArgument" title="cpl_core.configuration.console_argument.ConsoleArgument"><span class="pre">cpl_core.configuration.console_argument.ConsoleArgument</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_argument" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_argument">
|
||||
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">add_console_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argument</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_core.configuration.console_argument.ConsoleArgument" title="cpl_core.configuration.console_argument.ConsoleArgument"><span class="pre">cpl_core.configuration.console_argument.ConsoleArgument</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_argument" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds console argument to known console arguments</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -320,8 +230,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_arguments">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_console_arguments</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_arguments" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_arguments">
|
||||
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">add_console_arguments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_arguments" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Reads the console arguments</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -332,8 +242,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_environment_variables">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_environment_variables</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_environment_variables" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_environment_variables">
|
||||
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">add_environment_variables</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_environment_variables" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Reads the environment variables</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -344,8 +254,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_json_file</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file">
|
||||
<em class="property"><span class="pre">abstract</span> </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="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Reads and saves settings from given json file</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -361,24 +271,24 @@
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.additional_arguments">
|
||||
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">additional_arguments</span></code><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.additional_arguments" title="Permalink to this definition">¶</a></dt>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.additional_arguments">
|
||||
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">additional_arguments</span></span><em class="property"><span class="pre">:</span> <span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.additional_arguments" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function">
|
||||
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">argument_error_function</span></span><em class="property"><span class="pre">:</span> <span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.environment">
|
||||
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">environment</span></span><em class="property"><span class="pre">:</span> <a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></em><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.environment" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function">
|
||||
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">argument_error_function</span></code><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.environment">
|
||||
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">environment</span></code><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.environment" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">get_configuration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> → <span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration">
|
||||
<em class="property"><span class="pre">abstract</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="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="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><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></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>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -395,14 +305,14 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_core.configuration.configuration_model_abc">
|
||||
<span id="cpl-core-configuration-configuration-model-abc"></span><h2>cpl_core.configuration.configuration_model_abc<a class="headerlink" href="#module-cpl_core.configuration.configuration_model_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-configuration-configuration-model-abc"></span><h2>cpl_core.configuration.configuration_model_abc<a class="headerlink" href="#module-cpl_core.configuration.configuration_model_abc" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_model_abc.</span></code><code class="sig-name descname"><span class="pre">ConfigurationModelABC</span></code><a class="headerlink" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC">
|
||||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_model_abc.</span></span><span class="sig-name descname"><span class="pre">ConfigurationModelABC</span></span><a class="headerlink" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">from_dict</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict">
|
||||
<em class="property"><span class="pre">abstract</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="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>
|
||||
<blockquote>
|
||||
<div><p>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
|
||||
@ -413,69 +323,69 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_core.configuration.configuration_variable_name_enum">
|
||||
<span id="cpl-core-configuration-configuration-variable-name-enum"></span><h2>cpl_core.configuration.configuration_variable_name_enum<a class="headerlink" href="#module-cpl_core.configuration.configuration_variable_name_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-configuration-configuration-variable-name-enum"></span><h2>cpl_core.configuration.configuration_variable_name_enum<a class="headerlink" href="#module-cpl_core.configuration.configuration_variable_name_enum" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_variable_name_enum.</span></code><code class="sig-name descname"><span class="pre">ConfigurationVariableNameEnum</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_variable_name_enum.</span></span><span class="sig-name descname"><span class="pre">ConfigurationVariableNameEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
|
||||
<p>An enumeration.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.customer">
|
||||
<code class="sig-name descname"><span class="pre">customer</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'CUSTOMER'</span></em><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.customer" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.customer">
|
||||
<span class="sig-name descname"><span class="pre">customer</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'CUSTOMER'</span></em><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.customer" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.environment">
|
||||
<code class="sig-name descname"><span class="pre">environment</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'ENVIRONMENT'</span></em><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.environment" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.environment">
|
||||
<span class="sig-name descname"><span class="pre">environment</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'ENVIRONMENT'</span></em><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.environment" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.name">
|
||||
<code class="sig-name descname"><span class="pre">name</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'NAME'</span></em><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.name">
|
||||
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'NAME'</span></em><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.name" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.to_list">
|
||||
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">to_list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.to_list" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.to_list">
|
||||
<em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">to_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.to_list" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_core.configuration.console_argument">
|
||||
<span id="cpl-core-configuration-console-argument"></span><h2>cpl_core.configuration.console_argument<a class="headerlink" href="#module-cpl_core.configuration.console_argument" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-configuration-console-argument"></span><h2>cpl_core.configuration.console_argument<a class="headerlink" href="#module-cpl_core.configuration.console_argument" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.configuration.console_argument.ConsoleArgument">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.configuration.console_argument.</span></code><code class="sig-name descname"><span class="pre">ConsoleArgument</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value_token</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_value_token_optional</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.console_argument.ConsoleArgument">
|
||||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.console_argument.</span></span><span class="sig-name descname"><span class="pre">ConsoleArgument</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="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span><span 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="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_value_token_optional</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">'ConsoleArgument'</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.console_argument.ConsoleArgument.aliases">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">aliases</span></code><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.console_argument.ConsoleArgument.aliases">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="pre">:</span> <span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.aliases" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.console_argument.ConsoleArgument.console_arguments">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">console_arguments</span></code><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.console_arguments" title="Permalink to this definition">¶</a></dt>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.console_argument.ConsoleArgument.console_arguments">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">console_arguments</span></span><em class="property"><span class="pre">:</span> <span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">'ConsoleArgument'</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.console_arguments" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.console_argument.ConsoleArgument.is_value_token_optional">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">is_value_token_optional</span></code><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.is_value_token_optional" title="Permalink to this definition">¶</a></dt>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.console_argument.ConsoleArgument.is_value_token_optional">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">is_value_token_optional</span></span><em class="property"><span class="pre">:</span> <span class="pre">bool</span></em><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.is_value_token_optional" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.console_argument.ConsoleArgument.name">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">name</span></code><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.console_argument.ConsoleArgument.name">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.name" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.console_argument.ConsoleArgument.token">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">token</span></code><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.token" title="Permalink to this definition">¶</a></dt>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.console_argument.ConsoleArgument.token">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">token</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.token" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.configuration.console_argument.ConsoleArgument.value_token">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">value_token</span></code><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.value_token" title="Permalink to this definition">¶</a></dt>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.configuration.console_argument.ConsoleArgument.value_token">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">value_token</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#cpl_core.configuration.console_argument.ConsoleArgument.value_token" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -485,50 +395,33 @@
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cpl_core.console.html" class="btn btn-neutral float-right" title="cpl_core.console" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_core.application.html" class="btn btn-neutral float-left" title="cpl_core.application" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_core.console.html" class="btn btn-neutral float-right" title="cpl_core.console" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
367
docs/build/html/cpl_core.console.html
vendored
367
docs/build/html/cpl_core.console.html
vendored
File diff suppressed because one or more lines are too long
190
docs/build/html/cpl_core.database.connection.html
vendored
190
docs/build/html/cpl_core.database.connection.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>cpl_core.database.connection — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="cpl_core.database.context" href="cpl_core.database.context.html" />
|
||||
<link rel="prev" title="cpl_core.database" href="cpl_core.database.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -116,90 +68,47 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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</a> »</li>
|
||||
|
||||
<li>cpl_core.database.connection</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cpl_core.database.connection.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
|
||||
<div class="section" id="cpl-core-database-connection">
|
||||
<h1>cpl_core.database.connection<a class="headerlink" href="#cpl-core-database-connection" title="Permalink to this headline">¶</a></h1>
|
||||
<h1>cpl_core.database.connection<a class="headerlink" href="#cpl-core-database-connection" title="Permalink to this headline"></a></h1>
|
||||
<div class="section" id="module-cpl_core.database.connection.database_connection">
|
||||
<span id="cpl-core-database-connection-database-connection"></span><h2>cpl_core.database.connection.database_connection<a class="headerlink" href="#module-cpl_core.database.connection.database_connection" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-database-connection-database-connection"></span><h2>cpl_core.database.connection.database_connection<a class="headerlink" href="#module-cpl_core.database.connection.database_connection" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.database.connection.database_connection.DatabaseConnection">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.database.connection.database_connection.</span></code><code class="sig-name descname"><span class="pre">DatabaseConnection</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection.DatabaseConnection">
|
||||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.connection.database_connection.</span></span><span class="sig-name descname"><span class="pre">DatabaseConnection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC" title="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC</span></code></a></p>
|
||||
<p>Representation of the database connection</p>
|
||||
<blockquote>
|
||||
<div><p>database_settings: <a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></code></a></p>
|
||||
</div></blockquote>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.connection.database_connection.DatabaseConnection.connect">
|
||||
<code class="sig-name descname"><span class="pre">connect</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection_string</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection.connect" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection.DatabaseConnection.connect">
|
||||
<span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection_string</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection.connect" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Connects to a database by connection string</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -209,29 +118,29 @@
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.connection.database_connection.DatabaseConnection.engine">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">engine</span></code><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection.engine" title="Permalink to this definition">¶</a></dt>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection.DatabaseConnection.engine">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">engine</span></span><em class="property"><span class="pre">:</span> <span class="pre"><module</span> <span class="pre">'sqlalchemy.engine'</span> <span class="pre">from</span> <span class="pre">'/home/sven/Nextcloud_Sven/Schreibtisch/git_sh-edraft_de/sh_cpl/cpl-env/lib/python3.9/site-packages/sqlalchemy/engine/__init__.py'></span></em><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection.engine" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.connection.database_connection.DatabaseConnection.session">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">session</span></code><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection.session" title="Permalink to this definition">¶</a></dt>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection.DatabaseConnection.session">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">session</span></span><em class="property"><span class="pre">:</span> <span class="pre">sqlalchemy.orm.session.Session</span></em><a class="headerlink" href="#cpl_core.database.connection.database_connection.DatabaseConnection.session" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_core.database.connection.database_connection_abc">
|
||||
<span id="cpl-core-database-connection-database-connection-abc"></span><h2>cpl_core.database.connection.database_connection_abc<a class="headerlink" href="#module-cpl_core.database.connection.database_connection_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-database-connection-database-connection-abc"></span><h2>cpl_core.database.connection.database_connection_abc<a class="headerlink" href="#module-cpl_core.database.connection.database_connection_abc" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.database.connection.database_connection_abc.</span></code><code class="sig-name descname"><span class="pre">DatabaseConnectionABC</span></code><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC">
|
||||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.connection.database_connection_abc.</span></span><span class="sig-name descname"><span class="pre">DatabaseConnectionABC</span></span><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
|
||||
<p>ABC for the <a class="reference internal" href="#cpl_core.database.connection.database_connection.DatabaseConnection" title="cpl_core.database.connection.database_connection.DatabaseConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.connection.database_connection.DatabaseConnection</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.connect">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">connect</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection_string</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.connect" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.connect">
|
||||
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection_string</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.connect" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Connects to a database by connection string</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -241,14 +150,14 @@
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.engine">
|
||||
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">engine</span></code><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.engine" title="Permalink to this definition">¶</a></dt>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.engine">
|
||||
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">engine</span></span><em class="property"><span class="pre">:</span> <span class="pre"><module</span> <span class="pre">'sqlalchemy.engine'</span> <span class="pre">from</span> <span class="pre">'/home/sven/Nextcloud_Sven/Schreibtisch/git_sh-edraft_de/sh_cpl/cpl-env/lib/python3.9/site-packages/sqlalchemy/engine/__init__.py'></span></em><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.engine" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.session">
|
||||
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">session</span></code><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.session" title="Permalink to this definition">¶</a></dt>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.session">
|
||||
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">session</span></span><em class="property"><span class="pre">:</span> <span class="pre">sqlalchemy.orm.session.Session</span></em><a class="headerlink" href="#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.session" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -258,50 +167,33 @@
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cpl_core.database.context.html" class="btn btn-neutral float-right" title="cpl_core.database.context" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_core.database.html" class="btn btn-neutral float-left" title="cpl_core.database" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_core.database.context.html" class="btn btn-neutral float-right" title="cpl_core.database.context" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
198
docs/build/html/cpl_core.database.context.html
vendored
198
docs/build/html/cpl_core.database.context.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>cpl_core.database.context — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="cpl_core.dependency_injection" href="cpl_core.dependency_injection.html" />
|
||||
<link rel="prev" title="cpl_core.database.connection" href="cpl_core.database.connection.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -116,90 +68,47 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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</a> »</li>
|
||||
|
||||
<li>cpl_core.database.context</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cpl_core.database.context.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
|
||||
<div class="section" id="cpl-core-database-context">
|
||||
<h1>cpl_core.database.context<a class="headerlink" href="#cpl-core-database-context" title="Permalink to this headline">¶</a></h1>
|
||||
<h1>cpl_core.database.context<a class="headerlink" href="#cpl-core-database-context" title="Permalink to this headline"></a></h1>
|
||||
<div class="section" id="module-cpl_core.database.context.database_context">
|
||||
<span id="cpl-core-database-context-database-context"></span><h2>cpl_core.database.context.database_context<a class="headerlink" href="#module-cpl_core.database.context.database_context" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-database-context-database-context"></span><h2>cpl_core.database.context.database_context<a class="headerlink" href="#module-cpl_core.database.context.database_context" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.database.context.database_context.DatabaseContext">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.database.context.database_context.</span></code><code class="sig-name descname"><span class="pre">DatabaseContext</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext">
|
||||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.context.database_context.</span></span><span class="sig-name descname"><span class="pre">DatabaseContext</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.context.database_context_abc.DatabaseContextABC</span></code></a></p>
|
||||
<p>Representation of the database context</p>
|
||||
<blockquote>
|
||||
<div><p>database_settings: <a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></code></a></p>
|
||||
</div></blockquote>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.context.database_context.DatabaseContext.connect">
|
||||
<code class="sig-name descname"><span class="pre">connect</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection_string</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.connect" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext.connect">
|
||||
<span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection_string</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.connect" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Connects to a database by connection string</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -209,35 +118,35 @@
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.context.database_context.DatabaseContext.engine">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">engine</span></code><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.engine" title="Permalink to this definition">¶</a></dt>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext.engine">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">engine</span></span><em class="property"><span class="pre">:</span> <span class="pre"><module</span> <span class="pre">'sqlalchemy.engine'</span> <span class="pre">from</span> <span class="pre">'/home/sven/Nextcloud_Sven/Schreibtisch/git_sh-edraft_de/sh_cpl/cpl-env/lib/python3.9/site-packages/sqlalchemy/engine/__init__.py'></span></em><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.engine" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.context.database_context.DatabaseContext.save_changes">
|
||||
<code class="sig-name descname"><span class="pre">save_changes</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.save_changes" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext.save_changes">
|
||||
<span class="sig-name descname"><span class="pre">save_changes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.save_changes" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Saves changes of the database</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.context.database_context.DatabaseContext.session">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">session</span></code><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.session" title="Permalink to this definition">¶</a></dt>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context.DatabaseContext.session">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">session</span></span><em class="property"><span class="pre">:</span> <span class="pre">sqlalchemy.orm.session.Session</span></em><a class="headerlink" href="#cpl_core.database.context.database_context.DatabaseContext.session" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_core.database.context.database_context_abc">
|
||||
<span id="cpl-core-database-context-database-context-abc"></span><h2>cpl_core.database.context.database_context_abc<a class="headerlink" href="#module-cpl_core.database.context.database_context_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-database-context-database-context-abc"></span><h2>cpl_core.database.context.database_context_abc<a class="headerlink" href="#module-cpl_core.database.context.database_context_abc" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.database.context.database_context_abc.DatabaseContextABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.database.context.database_context_abc.</span></code><code class="sig-name descname"><span class="pre">DatabaseContextABC</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC">
|
||||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.context.database_context_abc.</span></span><span class="sig-name descname"><span class="pre">DatabaseContextABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
|
||||
<p>ABC for the <a class="reference internal" href="#cpl_core.database.context.database_context.DatabaseContext" title="cpl_core.database.context.database_context.DatabaseContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.context.database_context.DatabaseContext</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.context.database_context_abc.DatabaseContextABC.connect">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">connect</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection_string</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.connect" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC.connect">
|
||||
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection_string</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.connect" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Connects to a database by connection string</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -247,20 +156,20 @@
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.context.database_context_abc.DatabaseContextABC.engine">
|
||||
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">engine</span></code><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.engine" title="Permalink to this definition">¶</a></dt>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC.engine">
|
||||
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">engine</span></span><em class="property"><span class="pre">:</span> <span class="pre"><module</span> <span class="pre">'sqlalchemy.engine'</span> <span class="pre">from</span> <span class="pre">'/home/sven/Nextcloud_Sven/Schreibtisch/git_sh-edraft_de/sh_cpl/cpl-env/lib/python3.9/site-packages/sqlalchemy/engine/__init__.py'></span></em><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.engine" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.context.database_context_abc.DatabaseContextABC.save_changes">
|
||||
<code class="sig-name descname"><span class="pre">save_changes</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.save_changes" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC.save_changes">
|
||||
<span class="sig-name descname"><span class="pre">save_changes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.save_changes" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Saves changes of the database</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.context.database_context_abc.DatabaseContextABC.session">
|
||||
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">session</span></code><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.session" title="Permalink to this definition">¶</a></dt>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.context.database_context_abc.DatabaseContextABC.session">
|
||||
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">session</span></span><em class="property"><span class="pre">:</span> <span class="pre">sqlalchemy.orm.session.Session</span></em><a class="headerlink" href="#cpl_core.database.context.database_context_abc.DatabaseContextABC.session" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -270,50 +179,33 @@
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cpl_core.dependency_injection.html" class="btn btn-neutral float-right" title="cpl_core.dependency_injection" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_core.database.connection.html" class="btn btn-neutral float-left" title="cpl_core.database.connection" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_core.dependency_injection.html" class="btn btn-neutral float-right" title="cpl_core.dependency_injection" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
245
docs/build/html/cpl_core.database.html
vendored
245
docs/build/html/cpl_core.database.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>cpl_core.database — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="cpl_core.database.connection" href="cpl_core.database.connection.html" />
|
||||
<link rel="prev" title="cpl_core.console" href="cpl_core.console.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -112,75 +64,33 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cpl_core.database.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
|
||||
<div class="section" id="cpl-core-database">
|
||||
<h1>cpl_core.database<a class="headerlink" href="#cpl-core-database" title="Permalink to this headline">¶</a></h1>
|
||||
<h1>cpl_core.database<a class="headerlink" href="#cpl-core-database" title="Permalink to this headline"></a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.database.connection.html">cpl_core.database.connection</a><ul>
|
||||
@ -196,51 +106,51 @@
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-cpl_core.database.database_model">
|
||||
<span id="cpl-core-database-database-model"></span><h2>cpl_core.database.database_model<a class="headerlink" href="#module-cpl_core.database.database_model" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-database-database-model"></span><h2>cpl_core.database.database_model<a class="headerlink" href="#module-cpl_core.database.database_model" title="Permalink to this headline"></a></h2>
|
||||
</div>
|
||||
<div class="section" id="module-cpl_core.database.database_settings">
|
||||
<span id="cpl-core-database-database-settings"></span><h2>cpl_core.database.database_settings<a class="headerlink" href="#module-cpl_core.database.database_settings" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-database-database-settings"></span><h2>cpl_core.database.database_settings<a class="headerlink" href="#module-cpl_core.database.database_settings" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.database.database_settings.DatabaseSettings">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.database.database_settings.</span></code><code class="sig-name descname"><span class="pre">DatabaseSettings</span></code><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings">
|
||||
<em class="property"><span class="pre">class</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>
|
||||
<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">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a></p>
|
||||
<p>Represents settings for the database connection</p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.database_settings.DatabaseSettings.auth_plugin">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">auth_plugin</span></code><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.auth_plugin" title="Permalink to this definition">¶</a></dt>
|
||||
<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> </em><span class="sig-name descname"><span class="pre">auth_plugin</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</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.case_sensitive">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">case_sensitive</span></span><em class="property"><span class="pre">:</span> <span class="pre">bool</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.case_sensitive" 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.connection_string">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">connection_string</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.connection_string" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.credentials">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">credentials</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.credentials" 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.echo">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">echo</span></span><em class="property"><span class="pre">:</span> <span class="pre">bool</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.echo" 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.encoding">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">encoding</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.encoding" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.database_settings.DatabaseSettings.case_sensitive">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">case_sensitive</span></code><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.case_sensitive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.database_settings.DatabaseSettings.connection_string">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">connection_string</span></code><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.connection_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.database_settings.DatabaseSettings.credentials">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">credentials</span></code><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.credentials" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.database_settings.DatabaseSettings.echo">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">echo</span></code><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.echo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.database_settings.DatabaseSettings.encoding">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">encoding</span></code><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.encoding" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.database.database_settings.DatabaseSettings.from_dict">
|
||||
<code class="sig-name descname"><span class="pre">from_dict</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.from_dict" title="Permalink to this definition">¶</a></dt>
|
||||
<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="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>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
|
||||
</dd></dl>
|
||||
@ -249,40 +159,40 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_core.database.database_settings_name_enum">
|
||||
<span id="cpl-core-database-database-settings-name-enum"></span><h2>cpl_core.database.database_settings_name_enum<a class="headerlink" href="#module-cpl_core.database.database_settings_name_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-database-database-settings-name-enum"></span><h2>cpl_core.database.database_settings_name_enum<a class="headerlink" href="#module-cpl_core.database.database_settings_name_enum" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.database.database_settings_name_enum.</span></code><code class="sig-name descname"><span class="pre">DatabaseSettingsNameEnum</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.database_settings_name_enum.</span></span><span class="sig-name descname"><span class="pre">DatabaseSettingsNameEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
|
||||
<p>An enumeration.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.auth_plugin">
|
||||
<code class="sig-name descname"><span class="pre">auth_plugin</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'AuthPlugin'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.auth_plugin" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.auth_plugin">
|
||||
<span class="sig-name descname"><span class="pre">auth_plugin</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'AuthPlugin'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.auth_plugin" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.case_sensitive">
|
||||
<code class="sig-name descname"><span class="pre">case_sensitive</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'CaseSensitive'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.case_sensitive" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.case_sensitive">
|
||||
<span class="sig-name descname"><span class="pre">case_sensitive</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'CaseSensitive'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.case_sensitive" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.connection_string">
|
||||
<code class="sig-name descname"><span class="pre">connection_string</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'ConnectionString'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.connection_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.connection_string">
|
||||
<span class="sig-name descname"><span class="pre">connection_string</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'ConnectionString'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.connection_string" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.credentials">
|
||||
<code class="sig-name descname"><span class="pre">credentials</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Credentials'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.credentials" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.credentials">
|
||||
<span class="sig-name descname"><span class="pre">credentials</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'Credentials'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.credentials" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.echo">
|
||||
<code class="sig-name descname"><span class="pre">echo</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Echo'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.echo" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.echo">
|
||||
<span class="sig-name descname"><span class="pre">echo</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'Echo'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.echo" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.encoding">
|
||||
<code class="sig-name descname"><span class="pre">encoding</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'Encoding'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.encoding" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.encoding">
|
||||
<span class="sig-name descname"><span class="pre">encoding</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'Encoding'</span></em><a class="headerlink" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.encoding" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@ -292,50 +202,33 @@
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cpl_core.database.connection.html" class="btn btn-neutral float-right" title="cpl_core.database.connection" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_core.console.html" class="btn btn-neutral float-left" title="cpl_core.console" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_core.database.connection.html" class="btn btn-neutral float-right" title="cpl_core.database.connection" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
275
docs/build/html/cpl_core.dependency_injection.html
vendored
275
docs/build/html/cpl_core.dependency_injection.html
vendored
@ -1,70 +1,33 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>cpl_core.dependency_injection — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script 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/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.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="cpl_core.environment" href="cpl_core.environment.html" />
|
||||
<link rel="prev" title="cpl_core.database.context" href="cpl_core.database.context.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@ -72,18 +35,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||
@ -112,85 +64,43 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Common Python Library</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<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</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cpl_core.dependency_injection.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
|
||||
<div class="section" id="cpl-core-dependency-injection">
|
||||
<h1>cpl_core.dependency_injection<a class="headerlink" href="#cpl-core-dependency-injection" title="Permalink to this headline">¶</a></h1>
|
||||
<h1>cpl_core.dependency_injection<a class="headerlink" href="#cpl-core-dependency-injection" title="Permalink to this headline"></a></h1>
|
||||
<div class="section" id="module-cpl_core.dependency_injection.service_collection">
|
||||
<span id="cpl-core-dependency-injection-service-collection"></span><h2>cpl_core.dependency_injection.service_collection<a class="headerlink" href="#module-cpl_core.dependency_injection.service_collection" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-dependency-injection-service-collection"></span><h2>cpl_core.dependency_injection.service_collection<a class="headerlink" href="#module-cpl_core.dependency_injection.service_collection" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.dependency_injection.service_collection.ServiceCollection">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_collection.</span></code><code class="sig-name descname"><span class="pre">ServiceCollection</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection">
|
||||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_collection.</span></span><span class="sig-name descname"><span class="pre">ServiceCollection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
<p>Representation of the collection of services</p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_db_context">
|
||||
<code class="sig-name descname"><span class="pre">add_db_context</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_context_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">cpl_core.database.context.database_context_abc.DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_db_context" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_db_context">
|
||||
<span class="sig-name descname"><span class="pre">add_db_context</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_context_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">cpl_core.database.context.database_context_abc.DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_db_context" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds database context</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -203,14 +113,14 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_logging">
|
||||
<code class="sig-name descname"><span class="pre">add_logging</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_logging" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_logging">
|
||||
<span class="sig-name descname"><span class="pre">add_logging</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_logging" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds the CPL internal logger</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_scoped">
|
||||
<code class="sig-name descname"><span class="pre">add_scoped</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_scoped" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_scoped">
|
||||
<span class="sig-name descname"><span class="pre">add_scoped</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_scoped" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with scoped lifetime</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -223,8 +133,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_singleton">
|
||||
<code class="sig-name descname"><span class="pre">add_singleton</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">,</span> </span><span class="pre">object</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">,</span> </span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_singleton" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_singleton">
|
||||
<span class="sig-name descname"><span class="pre">add_singleton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">,</span> </span><span class="pre">object</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">,</span> </span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_singleton" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with singleton lifetime</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -237,8 +147,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_transient">
|
||||
<code class="sig-name descname"><span class="pre">add_transient</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_transient" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_transient">
|
||||
<span class="sig-name descname"><span class="pre">add_transient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_transient" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with transient lifetime</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -251,8 +161,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.dependency_injection.service_collection.ServiceCollection.build_service_provider">
|
||||
<code class="sig-name descname"><span class="pre">build_service_provider</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></a><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.build_service_provider" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.build_service_provider">
|
||||
<span class="sig-name descname"><span class="pre">build_service_provider</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.build_service_provider" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates instance of the service provider</p>
|
||||
<blockquote>
|
||||
<div><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
@ -263,15 +173,15 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_core.dependency_injection.service_collection_abc">
|
||||
<span id="cpl-core-dependency-injection-service-collection-abc"></span><h2>cpl_core.dependency_injection.service_collection_abc<a class="headerlink" href="#module-cpl_core.dependency_injection.service_collection_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-dependency-injection-service-collection-abc"></span><h2>cpl_core.dependency_injection.service_collection_abc<a class="headerlink" href="#module-cpl_core.dependency_injection.service_collection_abc" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_collection_abc.</span></code><code class="sig-name descname"><span class="pre">ServiceCollectionABC</span></code><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC">
|
||||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_collection_abc.</span></span><span class="sig-name descname"><span class="pre">ServiceCollectionABC</span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
|
||||
<p>ABC for the class <a class="reference internal" href="#cpl_core.dependency_injection.service_collection.ServiceCollection" title="cpl_core.dependency_injection.service_collection.ServiceCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection.ServiceCollection</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_db_context">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_db_context</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_context</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">cpl_core.database.context.database_context_abc.DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_db_context" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_db_context">
|
||||
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">add_db_context</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_context</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">cpl_core.database.context.database_context_abc.DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">cpl_core.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_db_context" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds database context</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -284,14 +194,14 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_logging">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_logging</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_logging" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_logging">
|
||||
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">add_logging</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_logging" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds the CPL internal logger</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_scoped</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped">
|
||||
<em class="property"><span class="pre">abstract</span> </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="n"><span class="pre">Type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_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>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -304,8 +214,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_singleton</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton">
|
||||
<em class="property"><span class="pre">abstract</span> </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="n"><span class="pre">Type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_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>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -318,8 +228,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_transient</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient">
|
||||
<em class="property"><span class="pre">abstract</span> </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="n"><span class="pre">Type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_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>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -332,8 +242,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.build_service_provider">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">build_service_provider</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></a><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.build_service_provider" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.build_service_provider">
|
||||
<em class="property"><span class="pre">abstract</span> </em><span class="sig-name descname"><span class="pre">build_service_provider</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.build_service_provider" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates instance of the service provider</p>
|
||||
<blockquote>
|
||||
<div><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
@ -344,10 +254,10 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_core.dependency_injection.service_descriptor">
|
||||
<span id="cpl-core-dependency-injection-service-descriptor"></span><h2>cpl_core.dependency_injection.service_descriptor<a class="headerlink" href="#module-cpl_core.dependency_injection.service_descriptor" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-dependency-injection-service-descriptor"></span><h2>cpl_core.dependency_injection.service_descriptor<a class="headerlink" href="#module-cpl_core.dependency_injection.service_descriptor" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_descriptor.</span></code><code class="sig-name descname"><span class="pre">ServiceDescriptor</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">implementation</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">,</span> </span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lifetime</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><span class="pre">cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor">
|
||||
<em class="property"><span class="pre">class</span> </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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">,</span> </span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lifetime</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><span class="pre">cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum</span></a></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>
|
||||
<blockquote>
|
||||
@ -358,54 +268,54 @@
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.implementation">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">implementation</span></code><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.implementation" title="Permalink to this definition">¶</a></dt>
|
||||
<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> </em><span class="sig-name descname"><span class="pre">implementation</span></span><em class="property"><span class="pre">:</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="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>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.lifetime">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">lifetime</span></code><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.lifetime" title="Permalink to this definition">¶</a></dt>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.lifetime">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">lifetime</span></span><em class="property"><span class="pre">:</span> <a class="reference internal" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><span class="pre">cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum</span></a></em><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.lifetime" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.service_type">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">service_type</span></code><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.service_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.service_type">
|
||||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">service_type</span></span><em class="property"><span class="pre">:</span> <span class="pre">type</span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.service_type" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_core.dependency_injection.service_lifetime_enum">
|
||||
<span id="cpl-core-dependency-injection-service-lifetime-enum"></span><h2>cpl_core.dependency_injection.service_lifetime_enum<a class="headerlink" href="#module-cpl_core.dependency_injection.service_lifetime_enum" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-dependency-injection-service-lifetime-enum"></span><h2>cpl_core.dependency_injection.service_lifetime_enum<a class="headerlink" href="#module-cpl_core.dependency_injection.service_lifetime_enum" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_lifetime_enum.</span></code><code class="sig-name descname"><span class="pre">ServiceLifetimeEnum</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum">
|
||||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_lifetime_enum.</span></span><span class="sig-name descname"><span class="pre">ServiceLifetimeEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
|
||||
<p>An enumeration.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.scoped">
|
||||
<code class="sig-name descname"><span class="pre">scoped</span></code><em class="property"> <span class="pre">=</span> <span class="pre">1</span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.scoped" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.scoped">
|
||||
<span class="sig-name descname"><span class="pre">scoped</span></span><em class="property"> <span class="pre">=</span> <span class="pre">1</span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.scoped" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.singleton">
|
||||
<code class="sig-name descname"><span class="pre">singleton</span></code><em class="property"> <span class="pre">=</span> <span class="pre">0</span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.singleton" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.singleton">
|
||||
<span class="sig-name descname"><span class="pre">singleton</span></span><em class="property"> <span class="pre">=</span> <span class="pre">0</span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.singleton" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.transient">
|
||||
<code class="sig-name descname"><span class="pre">transient</span></code><em class="property"> <span class="pre">=</span> <span class="pre">2</span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.transient" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.transient">
|
||||
<span class="sig-name descname"><span class="pre">transient</span></span><em class="property"> <span class="pre">=</span> <span class="pre">2</span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.transient" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_core.dependency_injection.service_provider">
|
||||
<span id="cpl-core-dependency-injection-service-provider"></span><h2>cpl_core.dependency_injection.service_provider<a class="headerlink" href="#module-cpl_core.dependency_injection.service_provider" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-dependency-injection-service-provider"></span><h2>cpl_core.dependency_injection.service_provider<a class="headerlink" href="#module-cpl_core.dependency_injection.service_provider" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.dependency_injection.service_provider.ServiceProvider">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_provider.</span></code><code class="sig-name descname"><span class="pre">ServiceProvider</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_descriptors</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_context</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">cpl_core.database.context.database_context_abc.DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider">
|
||||
<em class="property"><span class="pre">class</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="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="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_context</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">cpl_core.database.context.database_context_abc.DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_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">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
<p>Provider for the services</p>
|
||||
<blockquote>
|
||||
@ -419,8 +329,8 @@
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.dependency_injection.service_provider.ServiceProvider.build_service">
|
||||
<code class="sig-name descname"><span class="pre">build_service</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span> → <span class="pre">object</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.build_service" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.build_service">
|
||||
<span class="sig-name descname"><span class="pre">build_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="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>
|
||||
<dd><p>Creates instance of given type</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -434,8 +344,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.dependency_injection.service_provider.ServiceProvider.get_service">
|
||||
<code class="sig-name descname"><span class="pre">get_service</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span> → <span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.get_service" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.get_service">
|
||||
<span class="sig-name descname"><span class="pre">get_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></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>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -452,15 +362,15 @@
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_core.dependency_injection.service_provider_abc">
|
||||
<span id="cpl-core-dependency-injection-service-provider-abc"></span><h2>cpl_core.dependency_injection.service_provider_abc<a class="headerlink" href="#module-cpl_core.dependency_injection.service_provider_abc" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="cpl-core-dependency-injection-service-provider-abc"></span><h2>cpl_core.dependency_injection.service_provider_abc<a class="headerlink" href="#module-cpl_core.dependency_injection.service_provider_abc" title="Permalink to this headline"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_provider_abc.</span></code><code class="sig-name descname"><span class="pre">ServiceProviderABC</span></code><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC">
|
||||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_provider_abc.</span></span><span class="sig-name descname"><span class="pre">ServiceProviderABC</span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
|
||||
<p>ABC for the class <a class="reference internal" href="#cpl_core.dependency_injection.service_provider.ServiceProvider" title="cpl_core.dependency_injection.service_provider.ServiceProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_provider.ServiceProvider</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_service">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">build_service</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span></span></em><span class="sig-paren">)</span> → <span class="pre">object</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_service" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_service">
|
||||
<em class="property"><span class="pre">abstract</span> </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="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>
|
||||
<dd><p>Creates instance of given type</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -474,8 +384,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_service">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">get_service</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span></span></em><span class="sig-paren">)</span> → <span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_service" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_service">
|
||||
<em class="property"><span class="pre">abstract</span> </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="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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></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>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@ -495,50 +405,33 @@
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cpl_core.environment.html" class="btn btn-neutral float-right" title="cpl_core.environment" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_core.database.context.html" class="btn btn-neutral float-left" title="cpl_core.database.context" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_core.environment.html" class="btn btn-neutral float-right" title="cpl_core.environment" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user