Updated docs

This commit is contained in:
2023-04-05 21:43:21 +02:00
parent 4e2bdb2b59
commit 32223bcfc2
146 changed files with 5184 additions and 14675 deletions

View File

@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 7051b788adc6d655ae340e56640c6925
config: 7161cd79d6fb56140ef1c390e01dab1c
tags: 645f666f9bcd5a90fca523b33c5a78b7

View File

@@ -0,0 +1,69 @@
# Deprecated
## Table of Contents
1. [ConfigurationModelABC.from_dict](#ConfigurationModelABC-from_dict-method)
## ConfigurationModelABC from_dict method
We now process the configuration models directly in the configuration by recursive parameter parsing.
The JSONProcessor now goes through the JSON and the arguments of the __init__ and links the attributes by name from the
JSON and the name of the keyword argument.
Now, based on the type, either simply assigns the value. With a ``dict`` the processor is called recursively and so the
JSON is processed further. This way nested ConfigurationModels can be processed.
For this the code must be adapted as follows:
From this:
```sh
class VersionSettings(ConfigurationModelABC):
def __init__(self):
ConfigurationModelABC.__init__(self)
self.major: Optional[str] = "0"
self.minor: Optional[str] = "0"
self.micro: Optional[str] = "0"
def from_dict(self, settings: dict):
self.major = settings["Major"]
self.minor = settings["Minor"]
micro = settings["Micro"]
if micro != '':
self.micro = micro
```
To this:
```sh
class VersionSettings(ConfigurationModelABC):
def __init__(self, major: str = None, minor: str = None, micro: str = None):
ConfigurationModelABC.__init__(self)
self.major: Optional[str] = major
self.minor: Optional[str] = minor
self.micro: Optional[str] = micro if micro != "" else None
```
This makes the [from_dict](#from_dict) function obsolete.
A few rules must be observed:
- Only simple types can be processed
<br>
Wrong: ```dict[str, str]```
<br>
Correct: ```dict```
<br>
<br>
Incorrect: ```list[str]```
<br>
Correct: ```list```
- The arguments must be optional, i.e. created as kwargs
<br>
Incorrect: ```def __init__(self, x: int, y: int)```
<br>
Correct: ```def __init__(self, x: int = None, y: int = None)```

View File

@@ -14,7 +14,7 @@ This CPL docs help you learn, understand and use the package. From your first ap
Features
--------
- cpl-core
- Expandle
- Expandable
- Application base
- Standardized application classes
- Application object builder
@@ -87,6 +87,7 @@ These pages go into great detail about everything the Library can do.
introduction
getting_started
contributing
deprecated
cpl_cli
cpl_core
cpl_discord

View File

@@ -1,20 +1,9 @@
/*
* _sphinx_javascript_frameworks_compat.js
* ~~~~~~~~~~
*
* Compatability shim for jQuery and underscores.js.
*
* WILL BE REMOVED IN Sphinx 6.0
* xref RemovedInSphinx60Warning
/* Compatability shim for jQuery and underscores.js.
*
* Copyright Sphinx contributors
* Released under the two clause BSD licence
*/
/**
* select a different prefix for underscore
*/
$u = _.noConflict();
/**
* small helper function to urldecode strings
*

View File

@@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote {
a.headerlink {
visibility: hidden;
}
a.brackets:before,
span.brackets > a:before{
content: "[";
}
a.brackets:after,
span.brackets > a:after {
content: "]";
}
h1:hover > a.headerlink,
h2:hover > a.headerlink,
@@ -334,11 +324,17 @@ aside.sidebar {
p.sidebar-title {
font-weight: bold;
}
nav.contents,
aside.topic,
div.admonition, div.topic, blockquote {
clear: left;
}
/* -- topics ---------------------------------------------------------------- */
nav.contents,
aside.topic,
div.topic {
border: 1px solid #ccc;
padding: 7px;
@@ -377,6 +373,8 @@ div.body p.centered {
div.sidebar > :last-child,
aside.sidebar > :last-child,
nav.contents > :last-child,
aside.topic > :last-child,
div.topic > :last-child,
div.admonition > :last-child {
margin-bottom: 0;
@@ -384,6 +382,8 @@ div.admonition > :last-child {
div.sidebar::after,
aside.sidebar::after,
nav.contents::after,
aside.topic::after,
div.topic::after,
div.admonition::after,
blockquote::after {
@@ -609,25 +609,6 @@ ul.simple p {
margin-bottom: 0;
}
/* Docutils 0.17 and older (footnotes & citations) */
dl.footnote > dt,
dl.citation > dt {
float: left;
margin-right: 0.5em;
}
dl.footnote > dd,
dl.citation > dd {
margin-bottom: 0em;
}
dl.footnote > dd:after,
dl.citation > dd:after {
content: "";
clear: both;
}
/* Docutils 0.18+ (footnotes & citations) */
aside.footnote > span,
div.citation > span {
float: left;
@@ -652,8 +633,6 @@ div.citation > p:last-of-type:after {
clear: both;
}
/* Footnotes & citations ends */
dl.field-list {
display: grid;
grid-template-columns: fit-content(30%) auto;
@@ -666,10 +645,6 @@ dl.field-list > dt {
padding-right: 5px;
}
dl.field-list > dt:after {
content: ":";
}
dl.field-list > dd {
padding-left: 0.5em;
margin-top: 0em;

View File

@@ -1 +1 @@
.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}

File diff suppressed because one or more lines are too long

View File

@@ -4,12 +4,19 @@
*
* Base JavaScript utilities for all Sphinx HTML documentation.
*
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
"use strict";
const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([
"TEXTAREA",
"INPUT",
"SELECT",
"BUTTON",
]);
const _ready = (callback) => {
if (document.readyState !== "loading") {
callback();
@@ -18,73 +25,11 @@ const _ready = (callback) => {
}
};
/**
* highlight a given string on a node by wrapping it in
* span elements with the given class name.
*/
const _highlight = (node, addItems, text, className) => {
if (node.nodeType === Node.TEXT_NODE) {
const val = node.nodeValue;
const parent = node.parentNode;
const pos = val.toLowerCase().indexOf(text);
if (
pos >= 0 &&
!parent.classList.contains(className) &&
!parent.classList.contains("nohighlight")
) {
let span;
const closestNode = parent.closest("body, svg, foreignObject");
const isInSVG = closestNode && closestNode.matches("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.classList.add(className);
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
parent.insertBefore(
span,
parent.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling
)
);
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
const rect = document.createElementNS(
"http://www.w3.org/2000/svg",
"rect"
);
const bbox = parent.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute("class", className);
addItems.push({ parent: parent, target: rect });
}
}
} else if (node.matches && !node.matches("button, select, textarea")) {
node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
}
};
const _highlightText = (thisNode, text, className) => {
let addItems = [];
_highlight(thisNode, addItems, text, className);
addItems.forEach((obj) =>
obj.parent.insertAdjacentElement("beforebegin", obj.target)
);
};
/**
* Small JavaScript module for the documentation.
*/
const Documentation = {
init: () => {
Documentation.highlightSearchWords();
Documentation.initDomainIndexTable();
Documentation.initOnKeyListeners();
},
@@ -126,51 +71,6 @@ const Documentation = {
Documentation.LOCALE = catalog.locale;
},
/**
* highlight the search words provided in the url in the text
*/
highlightSearchWords: () => {
const highlight =
new URLSearchParams(window.location.search).get("highlight") || "";
const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
if (terms.length === 0) return; // nothing to do
// There should never be more than one element matching "div.body"
const divBody = document.querySelectorAll("div.body");
const body = divBody.length ? divBody[0] : document.querySelector("body");
window.setTimeout(() => {
terms.forEach((term) => _highlightText(body, term, "highlighted"));
}, 10);
const searchBox = document.getElementById("searchbox");
if (searchBox === null) return;
searchBox.appendChild(
document
.createRange()
.createContextualFragment(
'<p class="highlight-link">' +
'<a href="javascript:Documentation.hideSearchWords()">' +
Documentation.gettext("Hide Search Matches") +
"</a></p>"
)
);
},
/**
* helper function to hide the search marks again
*/
hideSearchWords: () => {
document
.querySelectorAll("#searchbox .highlight-link")
.forEach((el) => el.remove());
document
.querySelectorAll("span.highlighted")
.forEach((el) => el.classList.remove("highlighted"));
const url = new URL(window.location);
url.searchParams.delete("highlight");
window.history.replaceState({}, "", url);
},
/**
* helper function to focus on search bar
*/
@@ -210,15 +110,11 @@ const Documentation = {
)
return;
const blacklistedElements = new Set([
"TEXTAREA",
"INPUT",
"SELECT",
"BUTTON",
]);
document.addEventListener("keydown", (event) => {
if (blacklistedElements.has(document.activeElement.tagName)) return; // bail for input elements
if (event.altKey || event.ctrlKey || event.metaKey) return; // bail with special keys
// bail for input elements
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
// bail with special keys
if (event.altKey || event.ctrlKey || event.metaKey) return;
if (!event.shiftKey) {
switch (event.key) {
@@ -240,10 +136,6 @@ const Documentation = {
event.preventDefault();
}
break;
case "Escape":
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
Documentation.hideSearchWords();
event.preventDefault();
}
}

View File

@@ -10,5 +10,5 @@ var DOCUMENTATION_OPTIONS = {
SOURCELINK_SUFFIX: '.txt',
NAVIGATION_WITH_KEYS: false,
SHOW_SEARCH_SUMMARY: true,
ENABLE_SEARCH_SHORTCUTS: false,
ENABLE_SEARCH_SHORTCUTS: true,
};

File diff suppressed because it is too large Load Diff

View File

@@ -5,7 +5,7 @@
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/

View File

@@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for the full-text search.
*
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -57,14 +57,14 @@ const _removeChildren = (element) => {
const _escapeRegExp = (string) =>
string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
const _displayItem = (item, highlightTerms, searchTerms) => {
const _displayItem = (item, searchTerms) => {
const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT;
const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
const [docName, title, anchor, descr] = item;
const [docName, title, anchor, descr, score, _filename] = item;
let listItem = document.createElement("li");
let requestUrl;
@@ -82,13 +82,12 @@ const _displayItem = (item, highlightTerms, searchTerms) => {
requestUrl = docUrlRoot + docName + docFileSuffix;
linkUrl = docName + docLinkSuffix;
}
const params = new URLSearchParams();
params.set("highlight", [...highlightTerms].join(" "));
let linkEl = listItem.appendChild(document.createElement("a"));
linkEl.href = linkUrl + "?" + params.toString() + anchor;
linkEl.href = linkUrl + anchor;
linkEl.dataset.score = score;
linkEl.innerHTML = title;
if (descr)
listItem.appendChild(document.createElement("span")).innerText =
listItem.appendChild(document.createElement("span")).innerHTML =
" (" + descr + ")";
else if (showSearchSummary)
fetch(requestUrl)
@@ -96,7 +95,7 @@ const _displayItem = (item, highlightTerms, searchTerms) => {
.then((data) => {
if (data)
listItem.appendChild(
Search.makeSearchSummary(data, searchTerms, highlightTerms)
Search.makeSearchSummary(data, searchTerms)
);
});
Search.output.appendChild(listItem);
@@ -116,15 +115,14 @@ const _finishSearch = (resultCount) => {
const _displayNextItem = (
results,
resultCount,
highlightTerms,
searchTerms
) => {
// results left, load the summary and display it
// this is intended to be dynamic (don't sub resultsCount)
if (results.length) {
_displayItem(results.pop(), highlightTerms, searchTerms);
_displayItem(results.pop(), searchTerms);
setTimeout(
() => _displayNextItem(results, resultCount, highlightTerms, searchTerms),
() => _displayNextItem(results, resultCount, searchTerms),
5
);
}
@@ -155,10 +153,8 @@ const Search = {
_pulse_status: -1,
htmlToText: (htmlString) => {
const htmlElement = document
.createRange()
.createContextualFragment(htmlString);
_removeChildren(htmlElement.querySelectorAll(".headerlink"));
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() });
const docContent = htmlElement.querySelector('[role="main"]');
if (docContent !== undefined) return docContent.textContent;
console.warn(
@@ -239,6 +235,12 @@ const Search = {
* execute search (requires search index to be loaded)
*/
query: (query) => {
const filenames = Search._index.filenames;
const docNames = Search._index.docnames;
const titles = Search._index.titles;
const allTitles = Search._index.alltitles;
const indexEntries = Search._index.indexentries;
// stem the search terms and add them to the correct list
const stemmer = new Stemmer();
const searchTerms = new Set();
@@ -266,6 +268,10 @@ const Search = {
}
});
if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js
localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" "))
}
// console.debug("SEARCH: searching for:");
// console.info("required: ", [...searchTerms]);
// console.info("excluded: ", [...excludedTerms]);
@@ -274,6 +280,40 @@ const Search = {
let results = [];
_removeChildren(document.getElementById("search-progress"));
const queryLower = query.toLowerCase();
for (const [title, foundTitles] of Object.entries(allTitles)) {
if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) {
for (const [file, id] of foundTitles) {
let score = Math.round(100 * queryLower.length / title.length)
results.push([
docNames[file],
titles[file] !== title ? `${titles[file]} > ${title}` : title,
id !== null ? "#" + id : "",
null,
score,
filenames[file],
]);
}
}
}
// search for explicit entries in index directives
for (const [entry, foundEntries] of Object.entries(indexEntries)) {
if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
for (const [file, id] of foundEntries) {
let score = Math.round(100 * queryLower.length / entry.length)
results.push([
docNames[file],
titles[file],
id ? "#" + id : "",
null,
score,
filenames[file],
]);
}
}
}
// lookup as object
objectTerms.forEach((term) =>
results.push(...Search.performObjectSearch(term, objectTerms))
@@ -320,7 +360,7 @@ const Search = {
// console.info("search results:", Search.lastresults);
// print the results
_displayNextItem(results, results.length, highlightTerms, searchTerms);
_displayNextItem(results, results.length, searchTerms);
},
/**
@@ -401,8 +441,8 @@ const Search = {
// prepare search
const terms = Search._index.terms;
const titleTerms = Search._index.titleterms;
const docNames = Search._index.docnames;
const filenames = Search._index.filenames;
const docNames = Search._index.docnames;
const titles = Search._index.titles;
const scoreMap = new Map();
@@ -499,16 +539,15 @@ const Search = {
/**
* helper function to return a node containing the
* search summary for a given text. keywords is a list
* of stemmed words, highlightWords is the list of normal, unstemmed
* words. the first one is used to find the occurrence, the
* latter for highlighting it.
* of stemmed words.
*/
makeSearchSummary: (htmlText, keywords, highlightWords) => {
const text = Search.htmlToText(htmlText).toLowerCase();
makeSearchSummary: (htmlText, keywords) => {
const text = Search.htmlToText(htmlText);
if (text === "") return null;
const textLower = text.toLowerCase();
const actualStartPosition = [...keywords]
.map((k) => text.indexOf(k.toLowerCase()))
.map((k) => textLower.indexOf(k.toLowerCase()))
.filter((i) => i > -1)
.slice(-1)[0];
const startWithContext = Math.max(actualStartPosition - 120, 0);
@@ -516,13 +555,9 @@ const Search = {
const top = startWithContext === 0 ? "" : "...";
const tail = startWithContext + 240 < text.length ? "..." : "";
let summary = document.createElement("div");
let summary = document.createElement("p");
summary.classList.add("context");
summary.innerText = top + text.substr(startWithContext, 240).trim() + tail;
highlightWords.forEach((highlightWord) =>
_highlightText(summary, highlightWord, "highlighted")
);
summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
return summary;
},

View File

@@ -0,0 +1,144 @@
/* Highlighting utilities for Sphinx HTML documentation. */
"use strict";
const SPHINX_HIGHLIGHT_ENABLED = true
/**
* highlight a given string on a node by wrapping it in
* span elements with the given class name.
*/
const _highlight = (node, addItems, text, className) => {
if (node.nodeType === Node.TEXT_NODE) {
const val = node.nodeValue;
const parent = node.parentNode;
const pos = val.toLowerCase().indexOf(text);
if (
pos >= 0 &&
!parent.classList.contains(className) &&
!parent.classList.contains("nohighlight")
) {
let span;
const closestNode = parent.closest("body, svg, foreignObject");
const isInSVG = closestNode && closestNode.matches("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.classList.add(className);
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
parent.insertBefore(
span,
parent.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling
)
);
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
const rect = document.createElementNS(
"http://www.w3.org/2000/svg",
"rect"
);
const bbox = parent.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute("class", className);
addItems.push({ parent: parent, target: rect });
}
}
} else if (node.matches && !node.matches("button, select, textarea")) {
node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
}
};
const _highlightText = (thisNode, text, className) => {
let addItems = [];
_highlight(thisNode, addItems, text, className);
addItems.forEach((obj) =>
obj.parent.insertAdjacentElement("beforebegin", obj.target)
);
};
/**
* Small JavaScript module for the documentation.
*/
const SphinxHighlight = {
/**
* highlight the search words provided in localstorage in the text
*/
highlightSearchWords: () => {
if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight
// get and clear terms from localstorage
const url = new URL(window.location);
const highlight =
localStorage.getItem("sphinx_highlight_terms")
|| url.searchParams.get("highlight")
|| "";
localStorage.removeItem("sphinx_highlight_terms")
url.searchParams.delete("highlight");
window.history.replaceState({}, "", url);
// get individual terms from highlight string
const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
if (terms.length === 0) return; // nothing to do
// There should never be more than one element matching "div.body"
const divBody = document.querySelectorAll("div.body");
const body = divBody.length ? divBody[0] : document.querySelector("body");
window.setTimeout(() => {
terms.forEach((term) => _highlightText(body, term, "highlighted"));
}, 10);
const searchBox = document.getElementById("searchbox");
if (searchBox === null) return;
searchBox.appendChild(
document
.createRange()
.createContextualFragment(
'<p class="highlight-link">' +
'<a href="javascript:SphinxHighlight.hideSearchWords()">' +
_("Hide Search Matches") +
"</a></p>"
)
);
},
/**
* helper function to hide the search marks again
*/
hideSearchWords: () => {
document
.querySelectorAll("#searchbox .highlight-link")
.forEach((el) => el.remove());
document
.querySelectorAll("span.highlighted")
.forEach((el) => el.classList.remove("highlighted"));
localStorage.removeItem("sphinx_highlight_terms")
},
initEscapeListener: () => {
// only install a listener if it is really needed
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
document.addEventListener("keydown", (event) => {
// bail for input elements
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
// bail with special keys
if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
SphinxHighlight.hideSearchWords();
event.preventDefault();
}
});
},
};
_ready(SphinxHighlight.highlightSearchWords);
_ready(SphinxHighlight.initEscapeListener);

File diff suppressed because it is too large Load Diff

File diff suppressed because one or more lines are too long

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Contributing to CPL &mdash; Common Python Library documentation</title>
@@ -11,15 +11,15 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="CLI reference" href="cpl_cli.html" />
<link rel="next" title="Deprecated" href="deprecated.html" />
<link rel="prev" title="Using cpl g &amp; cpl n templating" href="tutorials.templating.html" />
</head>
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -57,6 +61,7 @@
<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -77,8 +82,8 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Contributing to CPL</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Contributing to CPL</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/contributing.md.txt" rel="nofollow"> View page source</a>
</li>
@@ -92,22 +97,22 @@
<h1>Contributing to CPL<a class="headerlink" href="#contributing-to-cpl" title="Permalink to this heading"></a></h1>
<p>We would love for you to contribute to CPL and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:</p>
<ul class="simple">
<li><p><span class="xref myst">Issuses and Bugs</span></p></li>
<li><p><span class="xref myst">Feature Request</span></p></li>
<li><p><span class="xref myst">Submission Guidelines</span></p></li>
<li><p><span class="xref myst">Coding Rules</span></p></li>
<li><p><span class="xref myst">License</span></p></li>
<li><p><a class="reference internal" href="#found-a-bug"><span class="xref myst">Issuses and Bugs</span></a></p></li>
<li><p><a class="reference internal" href="#feature-request"><span class="xref myst">Feature Request</span></a></p></li>
<li><p><a class="reference internal" href="#submission-guidelines"><span class="xref myst">Submission Guidelines</span></a></p></li>
<li><p><a class="reference internal" href="#coding-rules"><span class="xref myst">Coding Rules</span></a></p></li>
<li><p><a class="reference internal" href="#license"><span class="xref myst">License</span></a></p></li>
</ul>
<section id="found-a-bug">
<h2>Found a Bug?<a class="headerlink" href="#found-a-bug" title="Permalink to this heading"></a></h2>
<p>If you find a bug in the source code, you can help us by <span class="xref myst">submitting an issue</span> to our <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">Gitea Repository</a>. Even better, you can <span class="xref myst">submit a Pull Request</span> with a fix.</p>
<p>If you find a bug in the source code, you can help us by <a class="reference internal" href="#submitting-an-issue"><span class="xref myst">submitting an issue</span></a> to our <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">Gitea Repository</a>. Even better, you can <a class="reference internal" href="#submitting-a-pull-request"><span class="xref myst">submit a Pull Request</span></a> with a fix.</p>
</section>
<section id="feature-request">
<h2>Feature Request<a class="headerlink" href="#feature-request" title="Permalink to this heading"></a></h2>
<p>You can request a new feature by submitting an issue to our <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">Gitea Repository</a>. If you would like to implement a new feature, please consider the size of the change in order to determine the right steps to proceed:</p>
<p>For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.</p>
<p>Note: Adding a new topic to the documentation, or significantly re-writing a topic, counts as a major feature.</p>
<p>Small Features can be crafted and directly submitted as a <span class="xref myst">Pull Request</span>.</p>
<p>Small Features can be crafted and directly submitted as a <a class="reference internal" href="#submit-pr"><span class="xref myst">Pull Request</span></a>.</p>
</section>
<section id="submission-guidelines">
<h2>Submission Guidelines<a class="headerlink" href="#submission-guidelines" title="Permalink to this heading"></a></h2>
@@ -151,7 +156,7 @@
</section>
<section id="reviewing-a-pull-request">
<h3>Reviewing a Pull Request<a class="headerlink" href="#reviewing-a-pull-request" title="Permalink to this heading"></a></h3>
<p>The sh-edraft.de team reserves the right not to accept pull requests from community members who havent been good citizens of the community. Such behavior includes not following the CPL <span class="xref myst">coding rules</span> and applies within or outside of CPL managed channels.</p>
<p>The sh-edraft.de team reserves the right not to accept pull requests from community members who havent been good citizens of the community. Such behavior includes not following the CPL <a class="reference internal" href="#coding-rules"><span class="xref myst">coding rules</span></a> and applies within or outside of CPL managed channels.</p>
<section id="addressing-review-feedback">
<h4>Addressing review feedback<a class="headerlink" href="#addressing-review-feedback" title="Permalink to this heading"></a></h4>
<p>If we ask for changes via code reviews then:</p>
@@ -190,7 +195,7 @@ See <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/cp
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="tutorials.templating.html" class="btn btn-neutral float-left" title="Using cpl g &amp; cpl n templating" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cpl_cli.html" class="btn btn-neutral float-right" title="CLI reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="deprecated.html" class="btn btn-neutral float-right" title="Deprecated" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl add &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl add</a><ul>
@@ -84,9 +89,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI reference</a> &raquo;</li>
<li>cpl add</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
<li class="breadcrumb-item active">cpl add</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.add.md.txt" rel="nofollow"> View page source</a>
</li>
@@ -101,9 +106,9 @@
<section id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><span class="xref myst">Description</span></p></li>
<li><p><span class="xref myst">Arguments</span></p></li>
<li><p><span class="xref myst">Flags</span></p></li>
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
<li><p><a class="reference internal" href="#flags"><span class="xref myst">Flags</span></a></p></li>
</ul>
<p>Removes a project from workspace.</p>
<p>cpl <strong>add</strong> <em>&lt;source-project&gt;</em> <em>&lt;target-project&gt;</em> <br>
@@ -117,11 +122,11 @@ cpl <strong>A</strong> <em>&lt;source-project&gt;</em> <em>&lt;target-project&gt
</section>
<section id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this heading"></a></h2>
<table class="colwidths-auto docutils align-default">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-center head"><p>Description</p></th>
<th class="text-center head"><p>Value type</p></th>
<th class="head text-center"><p>Description</p></th>
<th class="head text-center"><p>Value type</p></th>
</tr>
</thead>
<tbody>
@@ -138,10 +143,10 @@ cpl <strong>A</strong> <em>&lt;source-project&gt;</em> <em>&lt;target-project&gt
</section>
<section id="flags">
<h2>Flags<a class="headerlink" href="#flags" title="Permalink to this heading"></a></h2>
<table class="colwidths-auto docutils align-default">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-center head"><p>Description</p></th>
<th class="head text-center"><p>Description</p></th>
</tr>
</thead>
<tbody>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl build &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
@@ -82,9 +87,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI reference</a> &raquo;</li>
<li>cpl build</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
<li class="breadcrumb-item active">cpl build</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.build.md.txt" rel="nofollow"> View page source</a>
</li>
@@ -99,7 +104,7 @@
<section id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><span class="xref myst">Description</span></p></li>
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
</ul>
<!-- - [Arguments](#arguments) -->
<p>Copies an python app into an output directory named build/ at the given output path. Must be executed within a CPL workspace or project directory</p>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl generate &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
@@ -84,9 +89,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI reference</a> &raquo;</li>
<li>cpl generate</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
<li class="breadcrumb-item active">cpl generate</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.generate.md.txt" rel="nofollow"> View page source</a>
</li>
@@ -101,9 +106,9 @@
<section id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><span class="xref myst">Description</span></p></li>
<li><p><span class="xref myst">Arguments</span></p></li>
<li><p><span class="xref myst">Schematics</span></p></li>
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
<li><p><a class="reference internal" href="#schematics"><span class="xref myst">Schematics</span></a></p></li>
</ul>
<p>Generate a file based on schematic.</p>
<p>cpl <strong>generate</strong> <em>&lt;schematic&gt;</em> <em>&lt;name&gt;</em> <br>
@@ -117,11 +122,11 @@ cpl <strong>G</strong> <em>&lt;schematic&gt;</em> <em>&lt;name&gt;</em></p>
</section>
<section id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this heading"></a></h2>
<table class="colwidths-auto docutils align-default">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-center head"><p>Description</p></th>
<th class="text-center head"><p>Value type</p></th>
<th class="head text-center"><p>Description</p></th>
<th class="head text-center"><p>Value type</p></th>
</tr>
</thead>
<tbody>
@@ -142,11 +147,11 @@ cpl <strong>G</strong> <em>&lt;schematic&gt;</em> <em>&lt;name&gt;</em></p>
</section>
<section id="schematics">
<h2>Schematics<a class="headerlink" href="#schematics" title="Permalink to this heading"></a></h2>
<table class="colwidths-auto docutils align-default">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Schematic</p></th>
<th class="text-center head"><p>Description</p></th>
<th class="text-center head"><p>Arguments</p></th>
<th class="head text-center"><p>Description</p></th>
<th class="head text-center"><p>Arguments</p></th>
</tr>
</thead>
<tbody>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl help &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
@@ -83,9 +88,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI reference</a> &raquo;</li>
<li>cpl help</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
<li class="breadcrumb-item active">cpl help</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.help.md.txt" rel="nofollow"> View page source</a>
</li>
@@ -100,8 +105,8 @@
<section id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><span class="xref myst">Description</span></p></li>
<li><p><span class="xref myst">Arguments</span></p></li>
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
</ul>
<p>Lists available command and their short descriptions.</p>
<p>cpl <strong>help</strong> <em>&lt;command&gt;</em> <br>
@@ -114,11 +119,11 @@ cpl <strong>H</strong> <em>&lt;command&gt;</em></p>
</section>
<section id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this heading"></a></h2>
<table class="colwidths-auto docutils align-default">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-center head"><p>Description</p></th>
<th class="text-center head"><p>Value type</p></th>
<th class="head text-center"><p>Description</p></th>
<th class="head text-center"><p>Value type</p></th>
</tr>
</thead>
<tbody>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>CLI reference &mdash; Common Python Library documentation</title>
@@ -11,16 +11,16 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="CLI Overview and Command Reference" href="cpl_cli.overview.html" />
<link rel="prev" title="Contributing to CPL" href="contributing.html" />
<link rel="prev" title="Deprecated" href="deprecated.html" />
</head>
<body class="wy-body-for-nav">
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">CLI reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
@@ -78,8 +83,8 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>CLI reference</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">CLI reference</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -177,7 +182,7 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="contributing.html" class="btn btn-neutral float-left" title="Contributing to CPL" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="deprecated.html" class="btn btn-neutral float-left" title="Deprecated" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cpl_cli.overview.html" class="btn btn-neutral float-right" title="CLI Overview and Command Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl install &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
@@ -84,9 +89,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI reference</a> &raquo;</li>
<li>cpl install</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
<li class="breadcrumb-item active">cpl install</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.install.md.txt" rel="nofollow"> View page source</a>
</li>
@@ -101,8 +106,8 @@
<section id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><span class="xref myst">Description</span></p></li>
<li><p><span class="xref myst">Arguments</span></p></li>
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
</ul>
<p>Installs given package via pip</p>
<p>cpl <strong>install</strong> <em>&lt;package&gt;</em> <br>
@@ -116,11 +121,11 @@ Without given package it will install the depedencies of the CPL project your in
</section>
<section id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this heading"></a></h2>
<table class="colwidths-auto docutils align-default">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-center head"><p>Description</p></th>
<th class="text-center head"><p>Value type</p></th>
<th class="head text-center"><p>Description</p></th>
<th class="head text-center"><p>Value type</p></th>
</tr>
</thead>
<tbody>
@@ -133,10 +138,10 @@ Without given package it will install the depedencies of the CPL project your in
</section>
<section id="flags">
<h2>Flags<a class="headerlink" href="#flags" title="Permalink to this heading"></a></h2>
<table class="colwidths-auto docutils align-default">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-center head"><p>Description</p></th>
<th class="head text-center"><p>Description</p></th>
</tr>
</thead>
<tbody>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl new &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
@@ -84,9 +89,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI reference</a> &raquo;</li>
<li>cpl new</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
<li class="breadcrumb-item active">cpl new</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.new.md.txt" rel="nofollow"> View page source</a>
</li>
@@ -101,9 +106,9 @@
<section id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><span class="xref myst">Description</span></p></li>
<li><p><span class="xref myst">Arguments</span></p></li>
<li><p><span class="xref myst">Project types</span></p></li>
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
<li><p><a class="reference internal" href="#project-types"><span class="xref myst">Project types</span></a></p></li>
</ul>
<p>Generates a workspace and initial project or add a project to workspace.</p>
<p>cpl <strong>new</strong> <em>&lt;type&gt;</em> <em>&lt;name&gt;</em><br>
@@ -115,16 +120,16 @@ cpl <strong>N</strong> <em>&lt;type&gt;</em> <em>&lt;name&gt;</em></p>
<p>Generates a workspace and initial project or add a project to workspace.</p>
<p>You can define custom project types by creating templates in a <code class="docutils literal notranslate"><span class="pre">.cpl</span></code> folder.</p>
<p>If the command is running in a CPL workspace, it will add the new project to the workspace.</p>
<table class="colwidths-auto docutils align-default">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-center head"><p>Description</p></th>
<th class="text-center head"><p>Value type</p></th>
<th class="head text-center"><p>Description</p></th>
<th class="head text-center"><p>Value type</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">&lt;type&gt;</span></code></p></td>
<td class="text-center"><p>The type of the project, see <span class="xref myst">types</span></p></td>
<td class="text-center"><p>The type of the project, see <a class="reference internal" href="#project-types"><span class="xref myst">types</span></a></p></td>
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">&lt;name&gt;</span></code></p></td>
@@ -140,10 +145,10 @@ cpl <strong>N</strong> <em>&lt;type&gt;</em> <em>&lt;name&gt;</em></p>
</section>
<section id="project-types">
<h2>Project types<a class="headerlink" href="#project-types" title="Permalink to this heading"></a></h2>
<table class="colwidths-auto docutils align-default">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Project type</p></th>
<th class="text-center head"><p>Description</p></th>
<th class="head text-center"><p>Description</p></th>
</tr>
</thead>
<tbody>
@@ -158,10 +163,10 @@ cpl <strong>N</strong> <em>&lt;type&gt;</em> <em>&lt;name&gt;</em></p>
</section>
<section id="flags">
<h2>Flags<a class="headerlink" href="#flags" title="Permalink to this heading"></a></h2>
<table class="colwidths-auto docutils align-default">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-center head"><p>Description</p></th>
<th class="head text-center"><p>Description</p></th>
</tr>
</thead>
<tbody>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>CLI Overview and Command Reference &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">CLI Overview and Command Reference</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#table-of-contents">Table of Contents</a></li>
@@ -88,9 +93,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI reference</a> &raquo;</li>
<li>CLI Overview and Command Reference</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
<li class="breadcrumb-item active">CLI Overview and Command Reference</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.overview.md.txt" rel="nofollow"> View page source</a>
</li>
@@ -105,11 +110,11 @@
<section id="table-of-contents">
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this heading"></a></h2>
<ol class="arabic simple">
<li><p><span class="xref myst">Install CPL</span></p></li>
<li><p><span class="xref myst">Install CPL CLI</span></p></li>
<li><p><span class="xref myst">Basic workflow</span></p></li>
<li><p><span class="xref myst">CLI command-language syntax</span></p></li>
<li><p><span class="xref myst">Command overview</span></p></li>
<li><p><a class="reference internal" href="#setup#install-the-package"><span class="xref myst">Install CPL</span></a></p></li>
<li><p><a class="reference internal" href="#setup#install-the-cli"><span class="xref myst">Install CPL CLI</span></a></p></li>
<li><p><a class="reference internal" href="#basic-workflow"><span class="xref myst">Basic workflow</span></a></p></li>
<li><p><a class="reference internal" href="#cli-command-language-syntax"><span class="xref myst">CLI command-language syntax</span></a></p></li>
<li><p><a class="reference internal" href="#command-overview"><span class="xref myst">Command overview</span></a></p></li>
</ol>
</section>
<section id="basic-workflow">
@@ -140,11 +145,11 @@ cpl<span class="w"> </span>start
</section>
<section id="command-overview">
<h2>Command overview<a class="headerlink" href="#command-overview" title="Permalink to this heading"></a></h2>
<table class="colwidths-auto docutils align-default">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Command</p></th>
<th class="text-center head"><p>Alias</p></th>
<th class="text-center head"><p>Description</p></th>
<th class="head text-center"><p>Alias</p></th>
<th class="head text-center"><p>Description</p></th>
</tr>
</thead>
<tbody>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl publish &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
@@ -82,9 +87,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI reference</a> &raquo;</li>
<li>cpl publish</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
<li class="breadcrumb-item active">cpl publish</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.publish.md.txt" rel="nofollow"> View page source</a>
</li>
@@ -99,7 +104,7 @@
<section id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><span class="xref myst">Description</span></p></li>
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
</ul>
<!-- - [Arguments](#arguments) -->
<p>Prepares files for publish into an output directory named dist/ at the given output path and executes <code class="docutils literal notranslate"><span class="pre">setup.py</span></code>.</p>
@@ -117,7 +122,8 @@ The command executes the <code class="docutils literal notranslate"><span class=
| Argument | Description | Value type |
| ------------- |:-------------:|:----------------:|
| ```<project>``` | The name of the project to build. Can be an console or a library. | ```str``` --></section>
| ```<project>``` | The name of the project to build. Can be an console or a library. | ```str``` -->
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl remove &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
@@ -84,9 +89,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI reference</a> &raquo;</li>
<li>cpl remove</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
<li class="breadcrumb-item active">cpl remove</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.remove.md.txt" rel="nofollow"> View page source</a>
</li>
@@ -101,8 +106,8 @@
<section id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><span class="xref myst">Description</span></p></li>
<li><p><span class="xref myst">Arguments</span></p></li>
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
</ul>
<p>Removes a project from workspace.</p>
<p>cpl <strong>remove</strong> <em>&lt;project&gt;</em> <br>
@@ -116,11 +121,11 @@ cpl <strong>R</strong> <em>&lt;project&gt;</em></p>
</section>
<section id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this heading"></a></h2>
<table class="colwidths-auto docutils align-default">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-center head"><p>Description</p></th>
<th class="text-center head"><p>Value type</p></th>
<th class="head text-center"><p>Description</p></th>
<th class="head text-center"><p>Value type</p></th>
</tr>
</thead>
<tbody>
@@ -133,10 +138,10 @@ cpl <strong>R</strong> <em>&lt;project&gt;</em></p>
</section>
<section id="flags">
<h2>Flags<a class="headerlink" href="#flags" title="Permalink to this heading"></a></h2>
<table class="colwidths-auto docutils align-default">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-center head"><p>Description</p></th>
<th class="head text-center"><p>Description</p></th>
</tr>
</thead>
<tbody>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl run &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
@@ -78,9 +83,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI reference</a> &raquo;</li>
<li>cpl run</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
<li class="breadcrumb-item active">cpl run</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.run.md.txt" rel="nofollow"> View page source</a>
</li>
@@ -96,11 +101,11 @@
<p>cpl <strong>run</strong> <br>
cpl <strong>r</strong> <br>
cpl <strong>R</strong></p>
<table class="colwidths-auto docutils align-default">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-center head"><p>Description</p></th>
<th class="text-center head"><p>Value type</p></th>
<th class="head text-center"><p>Description</p></th>
<th class="head text-center"><p>Value type</p></th>
</tr>
</thead>
<tbody>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl start &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
@@ -78,9 +83,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI reference</a> &raquo;</li>
<li>cpl start</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
<li class="breadcrumb-item active">cpl start</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.start.md.txt" rel="nofollow"> View page source</a>
</li>
@@ -96,11 +101,11 @@
<p>cpl <strong>start</strong> <br>
cpl <strong>s</strong> <br>
cpl <strong>S</strong></p>
<table class="colwidths-auto docutils align-default">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-center head"><p>Description</p></th>
<th class="text-center head"><p>Value type</p></th>
<th class="head text-center"><p>Description</p></th>
<th class="head text-center"><p>Value type</p></th>
</tr>
</thead>
<tbody>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl uninstall &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
@@ -84,9 +89,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI reference</a> &raquo;</li>
<li>cpl uninstall</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
<li class="breadcrumb-item active">cpl uninstall</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.uninstall.md.txt" rel="nofollow"> View page source</a>
</li>
@@ -101,8 +106,8 @@
<section id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><span class="xref myst">Description</span></p></li>
<li><p><span class="xref myst">Arguments</span></p></li>
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
<li><p><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments" title="cpl_core.configuration.configuration.Configuration.arguments"><span class="xref myst py py-attr">Arguments</span></a></p></li>
</ul>
<p>Uninstalls given package via pip</p>
<p>cpl <strong>uninstall</strong> <em>&lt;package&gt;</em> <br>
@@ -115,11 +120,11 @@ cpl <strong>UI</strong> <em>&lt;package&gt;</em></p>
</section>
<section id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this heading"></a></h2>
<table class="colwidths-auto docutils align-default">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-center head"><p>Description</p></th>
<th class="text-center head"><p>Value type</p></th>
<th class="head text-center"><p>Description</p></th>
<th class="head text-center"><p>Value type</p></th>
</tr>
</thead>
<tbody>
@@ -132,10 +137,10 @@ cpl <strong>UI</strong> <em>&lt;package&gt;</em></p>
</section>
<section id="flags">
<h2>Flags<a class="headerlink" href="#flags" title="Permalink to this heading"></a></h2>
<table class="colwidths-auto docutils align-default">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-center head"><p>Description</p></th>
<th class="head text-center"><p>Description</p></th>
</tr>
</thead>
<tbody>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl update &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
@@ -81,9 +86,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI reference</a> &raquo;</li>
<li>cpl update</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
<li class="breadcrumb-item active">cpl update</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.update.md.txt" rel="nofollow"> View page source</a>
</li>
@@ -101,10 +106,10 @@ cpl <strong>u</strong> <br>
cpl <strong>U</strong></p>
<section id="flags">
<h2>Flags<a class="headerlink" href="#flags" title="Permalink to this heading"></a></h2>
<table class="colwidths-auto docutils align-default">
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Argument</p></th>
<th class="text-center head"><p>Description</p></th>
<th class="head text-center"><p>Description</p></th>
</tr>
</thead>
<tbody>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl version &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
@@ -78,9 +83,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_cli.html">CLI reference</a> &raquo;</li>
<li>cpl version</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
<li class="breadcrumb-item active">cpl version</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_cli.version.md.txt" rel="nofollow"> View page source</a>
</li>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_core.application package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,18 +46,38 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.application package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_abc">cpl_core.application.application_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_builder">cpl_core.application.application_builder module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_builder_abc">cpl_core.application.application_builder_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_extension_abc">cpl_core.application.application_extension_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.startup_abc">cpl_core.application.startup_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.startup_extension_abc">cpl_core.application.startup_extension_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_abc">cpl_core.application.application_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.application_abc.ApplicationABC"><code class="docutils literal notranslate"><span class="pre">ApplicationABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_builder">cpl_core.application.application_builder module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.application_builder.ApplicationBuilder"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilder</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_builder_abc">cpl_core.application.application_builder_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.application_builder_abc.ApplicationBuilderABC"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilderABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_extension_abc">cpl_core.application.application_extension_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.application_extension_abc.ApplicationExtensionABC"><code class="docutils literal notranslate"><span class="pre">ApplicationExtensionABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.startup_abc">cpl_core.application.startup_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC"><code class="docutils literal notranslate"><span class="pre">StartupABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.startup_extension_abc">cpl_core.application.startup_extension_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.startup_extension_abc.StartupExtensionABC"><code class="docutils literal notranslate"><span class="pre">StartupExtensionABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.application.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -88,9 +112,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_core.html">API reference</a> &raquo;</li>
<li>cpl_core.application package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
<li class="breadcrumb-item active">cpl_core.application package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.application.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -188,7 +212,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.use_extension">
<span class="sig-name descname"><span class="pre">use_extension</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extension</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.application_extension_abc.ApplicationExtensionABC" title="cpl_core.application.application_extension_abc.ApplicationExtensionABC"><span class="pre">ApplicationExtensionABC</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.application.startup_extension_abc.StartupExtensionABC" title="cpl_core.application.startup_extension_abc.StartupExtensionABC"><span class="pre">StartupExtensionABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_builder.ApplicationBuilder" title="cpl_core.application.application_builder.ApplicationBuilder"><span class="pre">ApplicationBuilder</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_extension" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">use_extension</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extension</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.application_extension_abc.ApplicationExtensionABC" title="cpl_core.application.application_extension_abc.ApplicationExtensionABC"><span class="pre">ApplicationExtensionABC</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.application.startup_extension_abc.StartupExtensionABC" title="cpl_core.application.startup_extension_abc.StartupExtensionABC"><span class="pre">StartupExtensionABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_builder.ApplicationBuilder" title="cpl_core.application.application_builder.ApplicationBuilder"><span class="pre">ApplicationBuilder</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_extension" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
@@ -338,15 +362,16 @@ env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_co
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
<p>CPL core package</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2020 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.application.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.application.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -371,7 +396,6 @@ env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_co
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_core.configuration package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,25 +46,64 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.configuration package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_abc">cpl_core.configuration.argument_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_builder">cpl_core.configuration.argument_builder module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_executable_abc">cpl_core.configuration.argument_executable_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_type_enum">cpl_core.configuration.argument_type_enum module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration">cpl_core.configuration.configuration module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration_abc">cpl_core.configuration.configuration_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration_model_abc">cpl_core.configuration.configuration_model_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration_variable_name_enum">cpl_core.configuration.configuration_variable_name_enum module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.executable_argument">cpl_core.configuration.executable_argument module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.flag_argument">cpl_core.configuration.flag_argument module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.validator_abc">cpl_core.configuration.validator_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.variable_argument">cpl_core.configuration.variable_argument module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_abc">cpl_core.configuration.argument_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.argument_abc.ArgumentABC"><code class="docutils literal notranslate"><span class="pre">ArgumentABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_builder">cpl_core.configuration.argument_builder module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.argument_builder.ArgumentBuilder"><code class="docutils literal notranslate"><span class="pre">ArgumentBuilder</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_executable_abc">cpl_core.configuration.argument_executable_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC"><code class="docutils literal notranslate"><span class="pre">ArgumentExecutableABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.argument_type_enum">cpl_core.configuration.argument_type_enum module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum"><code class="docutils literal notranslate"><span class="pre">ArgumentTypeEnum</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration">cpl_core.configuration.configuration module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.configuration.Configuration"><code class="docutils literal notranslate"><span class="pre">Configuration</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration_abc">cpl_core.configuration.configuration_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="docutils literal notranslate"><span class="pre">ConfigurationABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration_model_abc">cpl_core.configuration.configuration_model_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.configuration_model_abc.base_func"><code class="docutils literal notranslate"><span class="pre">base_func()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration_variable_name_enum">cpl_core.configuration.configuration_variable_name_enum module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum"><code class="docutils literal notranslate"><span class="pre">ConfigurationVariableNameEnum</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.executable_argument">cpl_core.configuration.executable_argument module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.executable_argument.ExecutableArgument"><code class="docutils literal notranslate"><span class="pre">ExecutableArgument</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.flag_argument">cpl_core.configuration.flag_argument module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.flag_argument.FlagArgument"><code class="docutils literal notranslate"><span class="pre">FlagArgument</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.validator_abc">cpl_core.configuration.validator_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.validator_abc.ValidatorABC"><code class="docutils literal notranslate"><span class="pre">ValidatorABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.variable_argument">cpl_core.configuration.variable_argument module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.variable_argument.VariableArgument"><code class="docutils literal notranslate"><span class="pre">VariableArgument</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.configuration.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -94,9 +137,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_core.html">API reference</a> &raquo;</li>
<li>cpl_core.configuration package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
<li class="breadcrumb-item active">cpl_core.configuration package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.configuration.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -115,7 +158,7 @@
<span id="cpl-core-configuration-argument-abc-module"></span><h2>cpl_core.configuration.argument_abc module<a class="headerlink" href="#module-cpl_core.configuration.argument_abc" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.configuration.argument_abc.ArgumentABC">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.argument_abc.</span></span><span class="sig-name descname"><span class="pre">ArgumentABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.argument_abc.</span></span><span class="sig-name descname"><span class="pre">ArgumentABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.argument_abc.ArgumentABC.add_console_argument">
@@ -168,7 +211,7 @@
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.argument_builder.ArgumentBuilder.build_argument">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum" title="cpl_core.configuration.argument_type_enum.ArgumentTypeEnum"><span class="pre">ArgumentTypeEnum</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.executable_argument.ExecutableArgument" title="cpl_core.configuration.executable_argument.ExecutableArgument"><span class="pre">ExecutableArgument</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.configuration.flag_argument.FlagArgument" title="cpl_core.configuration.flag_argument.FlagArgument"><span class="pre">FlagArgument</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.configuration.variable_argument.VariableArgument" title="cpl_core.configuration.variable_argument.VariableArgument"><span class="pre">VariableArgument</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.configuration.argument_builder.ArgumentBuilder.build_argument" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_argument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum" title="cpl_core.configuration.argument_type_enum.ArgumentTypeEnum"><span class="pre">ArgumentTypeEnum</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.configuration.executable_argument.ExecutableArgument" title="cpl_core.configuration.executable_argument.ExecutableArgument"><span class="pre">ExecutableArgument</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.configuration.flag_argument.FlagArgument" title="cpl_core.configuration.flag_argument.FlagArgument"><span class="pre">FlagArgument</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.configuration.variable_argument.VariableArgument" title="cpl_core.configuration.variable_argument.VariableArgument"><span class="pre">VariableArgument</span></a></span></span><a class="headerlink" href="#cpl_core.configuration.argument_builder.ArgumentBuilder.build_argument" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@@ -262,7 +305,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.add_json_file">
<span class="sig-name descname"><span class="pre">add_json_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_json_file" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">add_json_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.add_json_file" title="Permalink to this definition"></a></dt>
<dd><p>Reads and saves settings from given json file</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -286,7 +329,7 @@
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.argument_error_function">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">argument_error_function</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.argument_error_function" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">argument_error_function</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.argument_error_function" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
@@ -339,7 +382,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.get_configuration">
<span class="sig-name descname"><span class="pre">get_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.get_configuration" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">get_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.get_configuration" title="Permalink to this definition"></a></dt>
<dd><p>Returns value from configuration by given type</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -354,7 +397,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration.Configuration.parse_console_arguments">
<span class="sig-name descname"><span class="pre">parse_console_arguments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.parse_console_arguments" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">parse_console_arguments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration.Configuration.parse_console_arguments" title="Permalink to this definition"></a></dt>
<dd><p>Reads the console arguments</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -419,7 +462,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_json_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_json_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file" title="Permalink to this definition"></a></dt>
<dd><p>Reads and saves settings from given json file</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -443,7 +486,7 @@
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function">
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">argument_error_function</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">argument_error_function</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
@@ -496,7 +539,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration" title="Permalink to this definition"></a></dt>
<dd><p>Returns value from configuration by given type</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -535,8 +578,9 @@
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict" title="Permalink to this definition"></a></dt>
<dd><p>Converts attributes to dict</p>
<span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict" title="Permalink to this definition"></a></dt>
<dd><p>DEPRECATED: Set attributes as typed arguments in __init__ instead. See &lt;&gt; for further information
Converts attributes to dict</p>
<dl class="simple">
<dt>Parameter:</dt><dd><p>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
</dd>
@@ -545,6 +589,11 @@
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cpl_core.configuration.configuration_model_abc.base_func">
<span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.configuration_model_abc.</span></span><span class="sig-name descname"><span class="pre">base_func</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.configuration_model_abc.base_func" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</section>
<section id="module-cpl_core.configuration.configuration_variable_name_enum">
<span id="cpl-core-configuration-configuration-variable-name-enum-module"></span><h2>cpl_core.configuration.configuration_variable_name_enum module<a class="headerlink" href="#module-cpl_core.configuration.configuration_variable_name_enum" title="Permalink to this heading"></a></h2>
@@ -580,7 +629,7 @@
<span id="cpl-core-configuration-executable-argument-module"></span><h2>cpl_core.configuration.executable_argument module<a class="headerlink" href="#module-cpl_core.configuration.executable_argument" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.configuration.executable_argument.ExecutableArgument">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.executable_argument.</span></span><span class="sig-name descname"><span class="pre">ExecutableArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC" title="cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC"><span class="pre">ArgumentExecutableABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validators</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.validator_abc.ValidatorABC" title="cpl_core.configuration.validator_abc.ValidatorABC"><span class="pre">cpl_core.configuration.validator_abc.ValidatorABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.executable_argument.ExecutableArgument" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.executable_argument.</span></span><span class="sig-name descname"><span class="pre">ExecutableArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC" title="cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC"><span class="pre">ArgumentExecutableABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validators</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.configuration.validator_abc.ValidatorABC" title="cpl_core.configuration.validator_abc.ValidatorABC"><span class="pre">cpl_core.configuration.validator_abc.ValidatorABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.executable_argument.ExecutableArgument" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="cpl_core.configuration.argument_abc.ArgumentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentABC</span></code></a></p>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.configuration.executable_argument.ExecutableArgument.executable_type">
@@ -610,7 +659,7 @@
<span id="cpl-core-configuration-flag-argument-module"></span><h2>cpl_core.configuration.flag_argument module<a class="headerlink" href="#module-cpl_core.configuration.flag_argument" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.configuration.flag_argument.FlagArgument">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.flag_argument.</span></span><span class="sig-name descname"><span class="pre">FlagArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.flag_argument.FlagArgument" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.flag_argument.</span></span><span class="sig-name descname"><span class="pre">FlagArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.flag_argument.FlagArgument" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="cpl_core.configuration.argument_abc.ArgumentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentABC</span></code></a></p>
</dd></dl>
@@ -633,7 +682,7 @@
<span id="cpl-core-configuration-variable-argument-module"></span><h2>cpl_core.configuration.variable_argument module<a class="headerlink" href="#module-cpl_core.configuration.variable_argument" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.configuration.variable_argument.VariableArgument">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.variable_argument.</span></span><span class="sig-name descname"><span class="pre">VariableArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value_token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.variable_argument.VariableArgument" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.variable_argument.</span></span><span class="sig-name descname"><span class="pre">VariableArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value_token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevent_next_executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_arguments</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ArgumentABC'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.variable_argument.VariableArgument" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl_core.configuration.argument_abc.ArgumentABC" title="cpl_core.configuration.argument_abc.ArgumentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentABC</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.configuration.variable_argument.VariableArgument.set_value">
@@ -659,15 +708,16 @@
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
<p>CPL core package</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2020 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.configuration.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.configuration.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.configuration.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -692,7 +742,6 @@
</dd></dl>
</section>
</section>
</section>

File diff suppressed because one or more lines are too long

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_core.database.connection package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
@@ -87,10 +92,10 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_core.html">API reference</a> &raquo;</li>
<li><a href="cpl_core.database.html">cpl_core.database package</a> &raquo;</li>
<li>cpl_core.database.connection package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
<li class="breadcrumb-item"><a href="cpl_core.database.html">cpl_core.database package</a></li>
<li class="breadcrumb-item active">cpl_core.database.connection package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.database.connection.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -177,15 +182,16 @@
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
<p>CPL core package</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2020 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.database.connection.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.connection.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.connection.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -210,7 +216,6 @@
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_core.database.context package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
@@ -87,10 +92,10 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_core.html">API reference</a> &raquo;</li>
<li><a href="cpl_core.database.html">cpl_core.database package</a> &raquo;</li>
<li>cpl_core.database.context package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
<li class="breadcrumb-item"><a href="cpl_core.database.html">cpl_core.database package</a></li>
<li class="breadcrumb-item active">cpl_core.database.context package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.database.context.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -201,15 +206,16 @@
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
<p>CPL core package</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2020 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.database.context.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.context.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.context.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -234,7 +240,6 @@
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_core.database package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
@@ -54,11 +59,21 @@
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings">cpl_core.database.database_settings module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.table_abc">cpl_core.database.table_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings">cpl_core.database.database_settings module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.database.database_settings.DatabaseSettings"><code class="docutils literal notranslate"><span class="pre">DatabaseSettings</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">DatabaseSettingsNameEnum</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.table_abc">cpl_core.database.table_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.database.table_abc.TableABC"><code class="docutils literal notranslate"><span class="pre">TableABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.database.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -90,9 +105,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_core.html">API reference</a> &raquo;</li>
<li>cpl_core.database package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
<li class="breadcrumb-item active">cpl_core.database package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.database.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -110,20 +125,66 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.database.connection.html">cpl_core.database.connection package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#module-cpl_core.database.connection.database_connection">cpl_core.database.connection.database_connection module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#module-cpl_core.database.connection.database_connection_abc">cpl_core.database.connection.database_connection_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#module-cpl_core.database.connection.database_connection">cpl_core.database.connection.database_connection module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection.DatabaseConnection"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection.DatabaseConnection.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection.connect()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection.DatabaseConnection.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection.cursor</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection.DatabaseConnection.server"><code class="docutils literal notranslate"><span class="pre">DatabaseConnection.server</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#module-cpl_core.database.connection.database_connection_abc">cpl_core.database.connection.database_connection_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC.connect()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC.cursor</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.database_connection_abc.DatabaseConnectionABC.server"><code class="docutils literal notranslate"><span class="pre">DatabaseConnectionABC.server</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.connection.html#module-cpl_core.database.connection">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.connection.html#cpl_core.database.connection.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#module-cpl_core.database.context.database_context">cpl_core.database.context.database_context module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#module-cpl_core.database.context.database_context_abc">cpl_core.database.context.database_context_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#module-cpl_core.database.context.database_context">cpl_core.database.context.database_context module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext"><code class="docutils literal notranslate"><span class="pre">DatabaseContext</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.connect()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.cursor</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext.save_changes"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.save_changes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context.DatabaseContext.select"><code class="docutils literal notranslate"><span class="pre">DatabaseContext.select()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#module-cpl_core.database.context.database_context_abc">cpl_core.database.context.database_context_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC.connect"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.connect()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC.cursor"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.cursor</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC.save_changes"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.save_changes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC.select"><code class="docutils literal notranslate"><span class="pre">DatabaseContextABC.select()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.context.html#module-cpl_core.database.context">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
@@ -138,60 +199,52 @@
<span id="cpl-core-database-database-settings-module"></span><h2>cpl_core.database.database_settings module<a class="headerlink" href="#module-cpl_core.database.database_settings" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.database_settings.</span></span><span class="sig-name descname"><span class="pre">DatabaseSettings</span></span><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.database_settings.</span></span><span class="sig-name descname"><span class="pre">DatabaseSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">databse</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">charset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_unicode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffered</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth_plugin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
<p>Represents settings for the database connection</p>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.auth_plugin">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">auth_plugin</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.auth_plugin" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">auth_plugin</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.auth_plugin" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.buffered">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">buffered</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.buffered" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">buffered</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.buffered" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.charset">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">charset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.charset" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">charset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.charset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.database">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">database</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.database" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">database</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.database" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.from_dict">
<span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.from_dict" title="Permalink to this definition"></a></dt>
<dd><p>Sets attributes from given dict</p>
<p>Parameter:
settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.host">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.host" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.host" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.password">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">password</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.password" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">password</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.password" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.port">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.port" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.port" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.use_unicode">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">use_unicode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.use_unicode" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">use_unicode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.use_unicode" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.database.database_settings.DatabaseSettings.user">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.user" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.database.database_settings.DatabaseSettings.user" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@@ -292,15 +345,16 @@ settings: <code class="xref py py-class docutils literal notranslate"><span clas
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
<p>CPL core package</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2020 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.database.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.database.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.database.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -325,7 +379,6 @@ settings: <code class="xref py py-class docutils literal notranslate"><span clas
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_core.dependency_injection package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
@@ -50,17 +55,45 @@
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html">cpl_core.database package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.dependency_injection package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.scope">cpl_core.dependency_injection.scope module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.scope_abc">cpl_core.dependency_injection.scope_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.scope_builder">cpl_core.dependency_injection.scope_builder module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_collection">cpl_core.dependency_injection.service_collection module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_collection_abc">cpl_core.dependency_injection.service_collection_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_descriptor">cpl_core.dependency_injection.service_descriptor module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_lifetime_enum">cpl_core.dependency_injection.service_lifetime_enum module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_provider">cpl_core.dependency_injection.service_provider module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_provider_abc">cpl_core.dependency_injection.service_provider_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.scope">cpl_core.dependency_injection.scope module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.scope.Scope"><code class="docutils literal notranslate"><span class="pre">Scope</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.scope_abc">cpl_core.dependency_injection.scope_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="docutils literal notranslate"><span class="pre">ScopeABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.scope_builder">cpl_core.dependency_injection.scope_builder module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.scope_builder.ScopeBuilder"><code class="docutils literal notranslate"><span class="pre">ScopeBuilder</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_collection">cpl_core.dependency_injection.service_collection module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection.ServiceCollection"><code class="docutils literal notranslate"><span class="pre">ServiceCollection</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_collection_abc">cpl_core.dependency_injection.service_collection_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="docutils literal notranslate"><span class="pre">ServiceCollectionABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_descriptor">cpl_core.dependency_injection.service_descriptor module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor"><code class="docutils literal notranslate"><span class="pre">ServiceDescriptor</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_lifetime_enum">cpl_core.dependency_injection.service_lifetime_enum module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><code class="docutils literal notranslate"><span class="pre">ServiceLifetimeEnum</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_provider">cpl_core.dependency_injection.service_provider module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider.ServiceProvider"><code class="docutils literal notranslate"><span class="pre">ServiceProvider</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_provider_abc">cpl_core.dependency_injection.service_provider_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="docutils literal notranslate"><span class="pre">ServiceProviderABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -91,9 +124,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_core.html">API reference</a> &raquo;</li>
<li>cpl_core.dependency_injection package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
<li class="breadcrumb-item active">cpl_core.dependency_injection package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.dependency_injection.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -213,7 +246,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_scoped">
<span class="sig-name descname"><span class="pre">add_scoped</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_scoped" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">add_scoped</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_scoped" title="Permalink to this definition"></a></dt>
<dd><p>Adds a service with scoped lifetime</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -230,7 +263,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_singleton">
<span class="sig-name descname"><span class="pre">add_singleton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_singleton" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">add_singleton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_singleton" title="Permalink to this definition"></a></dt>
<dd><p>Adds a service with singleton lifetime</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -247,7 +280,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_transient">
<span class="sig-name descname"><span class="pre">add_transient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_transient" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">add_transient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_transient" title="Permalink to this definition"></a></dt>
<dd><p>Adds a service with transient lifetime</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -315,7 +348,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_scoped</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_scoped</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped" title="Permalink to this definition"></a></dt>
<dd><p>Adds a service with scoped lifetime</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -332,7 +365,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_singleton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_singleton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton" title="Permalink to this definition"></a></dt>
<dd><p>Adds a service with singleton lifetime</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -349,7 +382,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_transient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_transient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient" title="Permalink to this definition"></a></dt>
<dd><p>Adds a service with transient lifetime</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -387,7 +420,7 @@
<span id="cpl-core-dependency-injection-service-descriptor-module"></span><h2>cpl_core.dependency_injection.service_descriptor module<a class="headerlink" href="#module-cpl_core.dependency_injection.service_descriptor" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_descriptor.</span></span><span class="sig-name descname"><span class="pre">ServiceDescriptor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">implementation</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lifetime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><span class="pre">ServiceLifetimeEnum</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_descriptor.</span></span><span class="sig-name descname"><span class="pre">ServiceDescriptor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">implementation</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">object</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lifetime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><span class="pre">ServiceLifetimeEnum</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Descriptor of a service</p>
<dl class="simple">
@@ -406,7 +439,7 @@
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.implementation">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">implementation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.implementation" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">implementation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">object</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.implementation" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
@@ -451,11 +484,13 @@
<span id="cpl-core-dependency-injection-service-provider-module"></span><h2>cpl_core.dependency_injection.service_provider module<a class="headerlink" href="#module-cpl_core.dependency_injection.service_provider" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_provider.</span></span><span class="sig-name descname"><span class="pre">ServiceProvider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_descriptors</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor" title="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor"><span class="pre">cpl_core.dependency_injection.service_descriptor.ServiceDescriptor</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_provider.</span></span><span class="sig-name descname"><span class="pre">ServiceProvider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_descriptors</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor" title="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor"><span class="pre">cpl_core.dependency_injection.service_descriptor.ServiceDescriptor</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">DatabaseContextABC</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceProviderABC</span></code></a></p>
<p>Provider for the services</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="parameter">
<h3>Parameter<a class="headerlink" href="#parameter" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>service_descriptors: list[<a class="reference internal" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor" title="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_descriptor.ServiceDescriptor</span></code></a>]</dt><dd><p>Descriptor of the service</p>
</dd>
<dt>config: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></code></a></dt><dd><p>CPL Configuration</p>
@@ -463,8 +498,7 @@
<dt>db_context: Optional[<a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database representation</p>
</dd>
</dl>
</dd>
</dl>
</div></blockquote>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.build_by_signature">
<span class="sig-name descname"><span class="pre">build_by_signature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sig</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Signature</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.build_by_signature" title="Permalink to this definition"></a></dt>
@@ -472,72 +506,95 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.build_service">
<span class="sig-name descname"><span class="pre">build_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.build_service" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">build_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.build_service" title="Permalink to this definition"></a></dt>
<dd><p>Creates instance of given type</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id1">
<h4>Parameter<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h4>
<blockquote>
<div><dl class="simple">
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code></dt><dd><p>The type of the searched instance</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><p>Object of the given type</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="returns">
<h4>Returns<a class="headerlink" href="#returns" title="Permalink to this heading"></a></h4>
<blockquote>
<div><p>Object of the given type</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.create_scope">
<span class="sig-name descname"><span class="pre">create_scope</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.create_scope" title="Permalink to this definition"></a></dt>
<dd><p>Creates a service scope</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></p>
</dd>
</dl>
<section id="id2">
<h4>Returns<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h4>
<blockquote>
<div><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.get_service">
<span class="sig-name descname"><span class="pre">get_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.get_service" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">get_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.get_service" title="Permalink to this definition"></a></dt>
<dd><p>Returns instance of given type</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id3">
<h4>Parameter<a class="headerlink" href="#id3" title="Permalink to this heading"></a></h4>
<blockquote>
<div><dl class="simple">
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><p>Object of type Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="id4">
<h4>Returns<a class="headerlink" href="#id4" title="Permalink to this heading"></a></h4>
<blockquote>
<div><p>Object of type Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.get_services">
<span class="sig-name descname"><span class="pre">get_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.get_services" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">get_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.get_services" title="Permalink to this definition"></a></dt>
<dd><p>Returns instance of given type</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id5">
<h4>Parameter<a class="headerlink" href="#id5" title="Permalink to this heading"></a></h4>
<blockquote>
<div><dl class="simple">
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><p>Object of type list[Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="id6">
<h4>Returns<a class="headerlink" href="#id6" title="Permalink to this heading"></a></h4>
<blockquote>
<div><p>Object of type list[Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.set_scope">
<span class="sig-name descname"><span class="pre">set_scope</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.set_scope" title="Permalink to this definition"></a></dt>
<dd><p>Sets the scope of service provider</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id7">
<h4>Parameter<a class="headerlink" href="#id7" title="Permalink to this heading"></a></h4>
<blockquote>
<div><dl class="simple">
<dt>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></dt><dd><p>Service scope</p>
</dd>
</dl>
</dd>
</dl>
</div></blockquote>
</section>
</dd></dl>
</section>
</dd></dl>
</section>
@@ -555,69 +612,95 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_service">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_service" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_service" title="Permalink to this definition"></a></dt>
<dd><p>Creates instance of given type</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id8">
<h3>Parameter<a class="headerlink" href="#id8" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code></dt><dd><p>The type of the searched instance</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><p>Object of the given type</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="id9">
<h3>Returns<a class="headerlink" href="#id9" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Object of the given type</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.create_scope">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_scope</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.create_scope" title="Permalink to this definition"></a></dt>
<dd><p>Creates a service scope</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></p>
</dd>
</dl>
<section id="id10">
<h3>Returns<a class="headerlink" href="#id10" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_service">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_service" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_service" title="Permalink to this definition"></a></dt>
<dd><p>Returns instance of given type</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id11">
<h3>Parameter<a class="headerlink" href="#id11" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><p>Object of type Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="id12">
<h3>Returns<a class="headerlink" href="#id12" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Object of type Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_services">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_services" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_services" title="Permalink to this definition"></a></dt>
<dd><p>Returns instance of given type</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id13">
<h3>Parameter<a class="headerlink" href="#id13" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><p>Object of type list[Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="id14">
<h3>Returns<a class="headerlink" href="#id14" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Object of type list[Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.inject">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">inject</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.inject" title="Permalink to this definition"></a></dt>
<dd><p>Decorator to allow injection into static and class methods</p>
<dl class="simple">
<dt>Parameter:</dt><dd><p>f: Callable</p>
</dd>
<dt>Returns:</dt><dd><p>function</p>
</dd>
</dl>
<section id="id15">
<h3>Parameter<a class="headerlink" href="#id15" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>f: Callable</p>
</div></blockquote>
</section>
<section id="id16">
<h3>Returns<a class="headerlink" href="#id16" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>function</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
@@ -629,13 +712,15 @@
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.set_scope">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_scope</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.set_scope" title="Permalink to this definition"></a></dt>
<dd><p>Sets the scope of service provider</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id17">
<h3>Parameter<a class="headerlink" href="#id17" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></dt><dd><p>Service scope</p>
</dd>
</dl>
</dd>
</dl>
</div></blockquote>
</section>
</dd></dl>
</dd></dl>
@@ -647,15 +732,16 @@
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
<p>CPL core package</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2020 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.dependency_injection.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -680,7 +766,6 @@
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_core.environment package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
@@ -51,11 +56,21 @@
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.environment package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.environment.application_environment">cpl_core.environment.application_environment module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.environment.application_environment_abc">cpl_core.environment.application_environment_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.environment.environment_name_enum">cpl_core.environment.environment_name_enum module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.environment.application_environment">cpl_core.environment.application_environment module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.environment.application_environment.ApplicationEnvironment"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironment</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.environment.application_environment_abc">cpl_core.environment.application_environment_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironmentABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.environment.environment_name_enum">cpl_core.environment.environment_name_enum module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.environment.environment_name_enum.EnvironmentNameEnum"><code class="docutils literal notranslate"><span class="pre">EnvironmentNameEnum</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.environment">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.environment.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -85,9 +100,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_core.html">API reference</a> &raquo;</li>
<li>cpl_core.environment package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
<li class="breadcrumb-item active">cpl_core.environment package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.environment.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -304,15 +319,16 @@
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
<p>CPL core package</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2020 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.environment.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.environment.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.environment.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -337,7 +353,6 @@
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>API reference &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
@@ -75,8 +80,8 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>API reference</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">API reference</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -92,47 +97,289 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application.application_abc">cpl_core.application.application_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application.application_builder">cpl_core.application.application_builder module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application.application_builder_abc">cpl_core.application.application_builder_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application.application_extension_abc">cpl_core.application.application_extension_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application.startup_abc">cpl_core.application.startup_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application.startup_extension_abc">cpl_core.application.startup_extension_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application.application_abc">cpl_core.application.application_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_abc.ApplicationABC"><code class="docutils literal notranslate"><span class="pre">ApplicationABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_abc.ApplicationABC.configure"><code class="docutils literal notranslate"><span class="pre">ApplicationABC.configure()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_abc.ApplicationABC.main"><code class="docutils literal notranslate"><span class="pre">ApplicationABC.main()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_abc.ApplicationABC.run"><code class="docutils literal notranslate"><span class="pre">ApplicationABC.run()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_abc.ApplicationABC.run_async"><code class="docutils literal notranslate"><span class="pre">ApplicationABC.run_async()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application.application_builder">cpl_core.application.application_builder module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_builder.ApplicationBuilder"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilder</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_builder.ApplicationBuilder.build"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilder.build()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_builder.ApplicationBuilder.build_async"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilder.build_async()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_builder.ApplicationBuilder.use_extension"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilder.use_extension()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_builder.ApplicationBuilder.use_startup"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilder.use_startup()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application.application_builder_abc">cpl_core.application.application_builder_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_builder_abc.ApplicationBuilderABC"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilderABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_builder_abc.ApplicationBuilderABC.build"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilderABC.build()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_builder_abc.ApplicationBuilderABC.build_async"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilderABC.build_async()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_builder_abc.ApplicationBuilderABC.use_startup"><code class="docutils literal notranslate"><span class="pre">ApplicationBuilderABC.use_startup()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application.application_extension_abc">cpl_core.application.application_extension_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_extension_abc.ApplicationExtensionABC"><code class="docutils literal notranslate"><span class="pre">ApplicationExtensionABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_extension_abc.ApplicationExtensionABC.run"><code class="docutils literal notranslate"><span class="pre">ApplicationExtensionABC.run()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application.startup_abc">cpl_core.application.startup_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.startup_abc.StartupABC"><code class="docutils literal notranslate"><span class="pre">StartupABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.startup_abc.StartupABC.configure_configuration"><code class="docutils literal notranslate"><span class="pre">StartupABC.configure_configuration()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.startup_abc.StartupABC.configure_services"><code class="docutils literal notranslate"><span class="pre">StartupABC.configure_services()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application.startup_extension_abc">cpl_core.application.startup_extension_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.startup_extension_abc.StartupExtensionABC"><code class="docutils literal notranslate"><span class="pre">StartupExtensionABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.startup_extension_abc.StartupExtensionABC.configure_configuration"><code class="docutils literal notranslate"><span class="pre">StartupExtensionABC.configure_configuration()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.startup_extension_abc.StartupExtensionABC.configure_services"><code class="docutils literal notranslate"><span class="pre">StartupExtensionABC.configure_services()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html#module-cpl_core.application">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.application.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.application.html#cpl_core.application.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.argument_abc">cpl_core.configuration.argument_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.argument_builder">cpl_core.configuration.argument_builder module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.argument_executable_abc">cpl_core.configuration.argument_executable_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.argument_type_enum">cpl_core.configuration.argument_type_enum module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.configuration">cpl_core.configuration.configuration module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.configuration_abc">cpl_core.configuration.configuration_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.configuration_model_abc">cpl_core.configuration.configuration_model_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.configuration_variable_name_enum">cpl_core.configuration.configuration_variable_name_enum module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.executable_argument">cpl_core.configuration.executable_argument module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.flag_argument">cpl_core.configuration.flag_argument module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.validator_abc">cpl_core.configuration.validator_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.variable_argument">cpl_core.configuration.variable_argument module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.argument_abc">cpl_core.configuration.argument_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.argument_abc.ArgumentABC"><code class="docutils literal notranslate"><span class="pre">ArgumentABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.argument_abc.ArgumentABC.add_console_argument"><code class="docutils literal notranslate"><span class="pre">ArgumentABC.add_console_argument()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.argument_abc.ArgumentABC.aliases"><code class="docutils literal notranslate"><span class="pre">ArgumentABC.aliases</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.argument_abc.ArgumentABC.console_arguments"><code class="docutils literal notranslate"><span class="pre">ArgumentABC.console_arguments</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.argument_abc.ArgumentABC.name"><code class="docutils literal notranslate"><span class="pre">ArgumentABC.name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.argument_abc.ArgumentABC.prevent_next_executable"><code class="docutils literal notranslate"><span class="pre">ArgumentABC.prevent_next_executable</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.argument_abc.ArgumentABC.token"><code class="docutils literal notranslate"><span class="pre">ArgumentABC.token</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.argument_builder">cpl_core.configuration.argument_builder module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.argument_builder.ArgumentBuilder"><code class="docutils literal notranslate"><span class="pre">ArgumentBuilder</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.argument_builder.ArgumentBuilder.build_argument"><code class="docutils literal notranslate"><span class="pre">ArgumentBuilder.build_argument()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.argument_executable_abc">cpl_core.configuration.argument_executable_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC"><code class="docutils literal notranslate"><span class="pre">ArgumentExecutableABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC.run"><code class="docutils literal notranslate"><span class="pre">ArgumentExecutableABC.run()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.argument_type_enum">cpl_core.configuration.argument_type_enum module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum"><code class="docutils literal notranslate"><span class="pre">ArgumentTypeEnum</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum.Executable"><code class="docutils literal notranslate"><span class="pre">ArgumentTypeEnum.Executable</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum.Flag"><code class="docutils literal notranslate"><span class="pre">ArgumentTypeEnum.Flag</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum.Variable"><code class="docutils literal notranslate"><span class="pre">ArgumentTypeEnum.Variable</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.configuration">cpl_core.configuration.configuration module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration"><code class="docutils literal notranslate"><span class="pre">Configuration</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.add_configuration"><code class="docutils literal notranslate"><span class="pre">Configuration.add_configuration()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.add_console_argument"><code class="docutils literal notranslate"><span class="pre">Configuration.add_console_argument()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.add_environment_variables"><code class="docutils literal notranslate"><span class="pre">Configuration.add_environment_variables()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.add_json_file"><code class="docutils literal notranslate"><span class="pre">Configuration.add_json_file()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.additional_arguments"><code class="docutils literal notranslate"><span class="pre">Configuration.additional_arguments</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.argument_error_function"><code class="docutils literal notranslate"><span class="pre">Configuration.argument_error_function</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.arguments"><code class="docutils literal notranslate"><span class="pre">Configuration.arguments</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.create_console_argument"><code class="docutils literal notranslate"><span class="pre">Configuration.create_console_argument()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.environment"><code class="docutils literal notranslate"><span class="pre">Configuration.environment</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.for_each_argument"><code class="docutils literal notranslate"><span class="pre">Configuration.for_each_argument()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.get_configuration"><code class="docutils literal notranslate"><span class="pre">Configuration.get_configuration()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration.Configuration.parse_console_arguments"><code class="docutils literal notranslate"><span class="pre">Configuration.parse_console_arguments()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.configuration_abc">cpl_core.configuration.configuration_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="docutils literal notranslate"><span class="pre">ConfigurationABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC.add_configuration"><code class="docutils literal notranslate"><span class="pre">ConfigurationABC.add_configuration()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_argument"><code class="docutils literal notranslate"><span class="pre">ConfigurationABC.add_console_argument()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC.add_environment_variables"><code class="docutils literal notranslate"><span class="pre">ConfigurationABC.add_environment_variables()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file"><code class="docutils literal notranslate"><span class="pre">ConfigurationABC.add_json_file()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC.additional_arguments"><code class="docutils literal notranslate"><span class="pre">ConfigurationABC.additional_arguments</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function"><code class="docutils literal notranslate"><span class="pre">ConfigurationABC.argument_error_function</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC.arguments"><code class="docutils literal notranslate"><span class="pre">ConfigurationABC.arguments</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC.create_console_argument"><code class="docutils literal notranslate"><span class="pre">ConfigurationABC.create_console_argument()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC.environment"><code class="docutils literal notranslate"><span class="pre">ConfigurationABC.environment</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC.for_each_argument"><code class="docutils literal notranslate"><span class="pre">ConfigurationABC.for_each_argument()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration"><code class="docutils literal notranslate"><span class="pre">ConfigurationABC.get_configuration()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC.parse_console_arguments"><code class="docutils literal notranslate"><span class="pre">ConfigurationABC.parse_console_arguments()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.configuration_model_abc">cpl_core.configuration.configuration_model_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict"><code class="docutils literal notranslate"><span class="pre">ConfigurationModelABC.from_dict()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.base_func"><code class="docutils literal notranslate"><span class="pre">base_func()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.configuration_variable_name_enum">cpl_core.configuration.configuration_variable_name_enum module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum"><code class="docutils literal notranslate"><span class="pre">ConfigurationVariableNameEnum</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.customer"><code class="docutils literal notranslate"><span class="pre">ConfigurationVariableNameEnum.customer</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.environment"><code class="docutils literal notranslate"><span class="pre">ConfigurationVariableNameEnum.environment</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.name"><code class="docutils literal notranslate"><span class="pre">ConfigurationVariableNameEnum.name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.to_list"><code class="docutils literal notranslate"><span class="pre">ConfigurationVariableNameEnum.to_list()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.executable_argument">cpl_core.configuration.executable_argument module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.executable_argument.ExecutableArgument"><code class="docutils literal notranslate"><span class="pre">ExecutableArgument</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.executable_argument.ExecutableArgument.executable_type"><code class="docutils literal notranslate"><span class="pre">ExecutableArgument.executable_type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.executable_argument.ExecutableArgument.run"><code class="docutils literal notranslate"><span class="pre">ExecutableArgument.run()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.executable_argument.ExecutableArgument.set_executable"><code class="docutils literal notranslate"><span class="pre">ExecutableArgument.set_executable()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.executable_argument.ExecutableArgument.validators"><code class="docutils literal notranslate"><span class="pre">ExecutableArgument.validators</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.flag_argument">cpl_core.configuration.flag_argument module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.flag_argument.FlagArgument"><code class="docutils literal notranslate"><span class="pre">FlagArgument</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.validator_abc">cpl_core.configuration.validator_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.validator_abc.ValidatorABC"><code class="docutils literal notranslate"><span class="pre">ValidatorABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.validator_abc.ValidatorABC.validate"><code class="docutils literal notranslate"><span class="pre">ValidatorABC.validate()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.variable_argument">cpl_core.configuration.variable_argument module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.variable_argument.VariableArgument"><code class="docutils literal notranslate"><span class="pre">VariableArgument</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.variable_argument.VariableArgument.set_value"><code class="docutils literal notranslate"><span class="pre">VariableArgument.set_value()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.variable_argument.VariableArgument.value"><code class="docutils literal notranslate"><span class="pre">VariableArgument.value</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.variable_argument.VariableArgument.value_token"><code class="docutils literal notranslate"><span class="pre">VariableArgument.value_token</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.console.html">cpl_core.console package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html#module-cpl_core.console.background_color_enum">cpl_core.console.background_color_enum module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html#module-cpl_core.console.console">cpl_core.console.console module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html#module-cpl_core.console.console_call">cpl_core.console.console_call module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html#module-cpl_core.console.foreground_color_enum">cpl_core.console.foreground_color_enum module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html#module-cpl_core.console.spinner_thread">cpl_core.console.spinner_thread module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html#module-cpl_core.console.background_color_enum">cpl_core.console.background_color_enum module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.background_color_enum.BackgroundColorEnum"><code class="docutils literal notranslate"><span class="pre">BackgroundColorEnum</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.background_color_enum.BackgroundColorEnum.blue"><code class="docutils literal notranslate"><span class="pre">BackgroundColorEnum.blue</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.background_color_enum.BackgroundColorEnum.cyan"><code class="docutils literal notranslate"><span class="pre">BackgroundColorEnum.cyan</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.background_color_enum.BackgroundColorEnum.default"><code class="docutils literal notranslate"><span class="pre">BackgroundColorEnum.default</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.background_color_enum.BackgroundColorEnum.green"><code class="docutils literal notranslate"><span class="pre">BackgroundColorEnum.green</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.background_color_enum.BackgroundColorEnum.grey"><code class="docutils literal notranslate"><span class="pre">BackgroundColorEnum.grey</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.background_color_enum.BackgroundColorEnum.magenta"><code class="docutils literal notranslate"><span class="pre">BackgroundColorEnum.magenta</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.background_color_enum.BackgroundColorEnum.red"><code class="docutils literal notranslate"><span class="pre">BackgroundColorEnum.red</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.background_color_enum.BackgroundColorEnum.white"><code class="docutils literal notranslate"><span class="pre">BackgroundColorEnum.white</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.background_color_enum.BackgroundColorEnum.yellow"><code class="docutils literal notranslate"><span class="pre">BackgroundColorEnum.yellow</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html#module-cpl_core.console.console">cpl_core.console.console module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console"><code class="docutils literal notranslate"><span class="pre">Console</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.background_color"><code class="docutils literal notranslate"><span class="pre">Console.background_color</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.banner"><code class="docutils literal notranslate"><span class="pre">Console.banner()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.clear"><code class="docutils literal notranslate"><span class="pre">Console.clear()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.close"><code class="docutils literal notranslate"><span class="pre">Console.close()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.color_reset"><code class="docutils literal notranslate"><span class="pre">Console.color_reset()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.disable"><code class="docutils literal notranslate"><span class="pre">Console.disable()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.enable"><code class="docutils literal notranslate"><span class="pre">Console.enable()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.error"><code class="docutils literal notranslate"><span class="pre">Console.error()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.foreground_color"><code class="docutils literal notranslate"><span class="pre">Console.foreground_color</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.read"><code class="docutils literal notranslate"><span class="pre">Console.read()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.read_line"><code class="docutils literal notranslate"><span class="pre">Console.read_line()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.reset_cursor_position"><code class="docutils literal notranslate"><span class="pre">Console.reset_cursor_position()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.select"><code class="docutils literal notranslate"><span class="pre">Console.select()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.set_background_color"><code class="docutils literal notranslate"><span class="pre">Console.set_background_color()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.set_cursor_position"><code class="docutils literal notranslate"><span class="pre">Console.set_cursor_position()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.set_foreground_color"><code class="docutils literal notranslate"><span class="pre">Console.set_foreground_color()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.set_hold_back"><code class="docutils literal notranslate"><span class="pre">Console.set_hold_back()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.spinner"><code class="docutils literal notranslate"><span class="pre">Console.spinner()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.table"><code class="docutils literal notranslate"><span class="pre">Console.table()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.write"><code class="docutils literal notranslate"><span class="pre">Console.write()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.write_at"><code class="docutils literal notranslate"><span class="pre">Console.write_at()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.write_line"><code class="docutils literal notranslate"><span class="pre">Console.write_line()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console.Console.write_line_at"><code class="docutils literal notranslate"><span class="pre">Console.write_line_at()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html#module-cpl_core.console.console_call">cpl_core.console.console_call module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console_call.ConsoleCall"><code class="docutils literal notranslate"><span class="pre">ConsoleCall</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console_call.ConsoleCall.args"><code class="docutils literal notranslate"><span class="pre">ConsoleCall.args</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.console_call.ConsoleCall.function"><code class="docutils literal notranslate"><span class="pre">ConsoleCall.function</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html#module-cpl_core.console.foreground_color_enum">cpl_core.console.foreground_color_enum module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.foreground_color_enum.ForegroundColorEnum"><code class="docutils literal notranslate"><span class="pre">ForegroundColorEnum</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.foreground_color_enum.ForegroundColorEnum.blue"><code class="docutils literal notranslate"><span class="pre">ForegroundColorEnum.blue</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.foreground_color_enum.ForegroundColorEnum.cyan"><code class="docutils literal notranslate"><span class="pre">ForegroundColorEnum.cyan</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.foreground_color_enum.ForegroundColorEnum.default"><code class="docutils literal notranslate"><span class="pre">ForegroundColorEnum.default</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.foreground_color_enum.ForegroundColorEnum.green"><code class="docutils literal notranslate"><span class="pre">ForegroundColorEnum.green</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.foreground_color_enum.ForegroundColorEnum.grey"><code class="docutils literal notranslate"><span class="pre">ForegroundColorEnum.grey</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.foreground_color_enum.ForegroundColorEnum.magenta"><code class="docutils literal notranslate"><span class="pre">ForegroundColorEnum.magenta</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.foreground_color_enum.ForegroundColorEnum.red"><code class="docutils literal notranslate"><span class="pre">ForegroundColorEnum.red</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.foreground_color_enum.ForegroundColorEnum.white"><code class="docutils literal notranslate"><span class="pre">ForegroundColorEnum.white</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.foreground_color_enum.ForegroundColorEnum.yellow"><code class="docutils literal notranslate"><span class="pre">ForegroundColorEnum.yellow</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html#module-cpl_core.console.spinner_thread">cpl_core.console.spinner_thread module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.spinner_thread.SpinnerThread"><code class="docutils literal notranslate"><span class="pre">SpinnerThread</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.spinner_thread.SpinnerThread.exit"><code class="docutils literal notranslate"><span class="pre">SpinnerThread.exit()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.spinner_thread.SpinnerThread.run"><code class="docutils literal notranslate"><span class="pre">SpinnerThread.run()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.spinner_thread.SpinnerThread.stop_spinning"><code class="docutils literal notranslate"><span class="pre">SpinnerThread.stop_spinning()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html#module-cpl_core.console">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.console.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.console.html#cpl_core.console.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
@@ -156,102 +403,517 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings">cpl_core.database.database_settings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.table_abc">cpl_core.database.table_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings">cpl_core.database.database_settings module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings"><code class="docutils literal notranslate"><span class="pre">DatabaseSettings</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings.auth_plugin"><code class="docutils literal notranslate"><span class="pre">DatabaseSettings.auth_plugin</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings.buffered"><code class="docutils literal notranslate"><span class="pre">DatabaseSettings.buffered</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings.charset"><code class="docutils literal notranslate"><span class="pre">DatabaseSettings.charset</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings.database"><code class="docutils literal notranslate"><span class="pre">DatabaseSettings.database</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings.host"><code class="docutils literal notranslate"><span class="pre">DatabaseSettings.host</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings.password"><code class="docutils literal notranslate"><span class="pre">DatabaseSettings.password</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings.port"><code class="docutils literal notranslate"><span class="pre">DatabaseSettings.port</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings.use_unicode"><code class="docutils literal notranslate"><span class="pre">DatabaseSettings.use_unicode</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings.user"><code class="docutils literal notranslate"><span class="pre">DatabaseSettings.user</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">DatabaseSettingsNameEnum</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.auth_plugin"><code class="docutils literal notranslate"><span class="pre">DatabaseSettingsNameEnum.auth_plugin</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.buffered"><code class="docutils literal notranslate"><span class="pre">DatabaseSettingsNameEnum.buffered</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.charset"><code class="docutils literal notranslate"><span class="pre">DatabaseSettingsNameEnum.charset</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.database"><code class="docutils literal notranslate"><span class="pre">DatabaseSettingsNameEnum.database</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.host"><code class="docutils literal notranslate"><span class="pre">DatabaseSettingsNameEnum.host</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.password"><code class="docutils literal notranslate"><span class="pre">DatabaseSettingsNameEnum.password</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.port"><code class="docutils literal notranslate"><span class="pre">DatabaseSettingsNameEnum.port</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.use_unicode"><code class="docutils literal notranslate"><span class="pre">DatabaseSettingsNameEnum.use_unicode</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.database_settings_name_enum.DatabaseSettingsNameEnum.user"><code class="docutils literal notranslate"><span class="pre">DatabaseSettingsNameEnum.user</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.table_abc">cpl_core.database.table_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.table_abc.TableABC"><code class="docutils literal notranslate"><span class="pre">TableABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.table_abc.TableABC.created_at"><code class="docutils literal notranslate"><span class="pre">TableABC.created_at</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.table_abc.TableABC.delete_string"><code class="docutils literal notranslate"><span class="pre">TableABC.delete_string</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.table_abc.TableABC.insert_string"><code class="docutils literal notranslate"><span class="pre">TableABC.insert_string</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.table_abc.TableABC.modified_at"><code class="docutils literal notranslate"><span class="pre">TableABC.modified_at</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.table_abc.TableABC.udpate_string"><code class="docutils literal notranslate"><span class="pre">TableABC.udpate_string</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.database.html#cpl_core.database.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.scope">cpl_core.dependency_injection.scope module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.scope_abc">cpl_core.dependency_injection.scope_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.scope_builder">cpl_core.dependency_injection.scope_builder module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_collection">cpl_core.dependency_injection.service_collection module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_collection_abc">cpl_core.dependency_injection.service_collection_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_descriptor">cpl_core.dependency_injection.service_descriptor module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_lifetime_enum">cpl_core.dependency_injection.service_lifetime_enum module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_provider">cpl_core.dependency_injection.service_provider module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_provider_abc">cpl_core.dependency_injection.service_provider_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.scope">cpl_core.dependency_injection.scope module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.scope.Scope"><code class="docutils literal notranslate"><span class="pre">Scope</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.scope.Scope.dispose"><code class="docutils literal notranslate"><span class="pre">Scope.dispose()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.scope.Scope.service_provider"><code class="docutils literal notranslate"><span class="pre">Scope.service_provider</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.scope_abc">cpl_core.dependency_injection.scope_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="docutils literal notranslate"><span class="pre">ScopeABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.scope_abc.ScopeABC.dispose"><code class="docutils literal notranslate"><span class="pre">ScopeABC.dispose()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.scope_abc.ScopeABC.service_provider"><code class="docutils literal notranslate"><span class="pre">ScopeABC.service_provider</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.scope_builder">cpl_core.dependency_injection.scope_builder module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.scope_builder.ScopeBuilder"><code class="docutils literal notranslate"><span class="pre">ScopeBuilder</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.scope_builder.ScopeBuilder.build"><code class="docutils literal notranslate"><span class="pre">ScopeBuilder.build()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_collection">cpl_core.dependency_injection.service_collection module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection.ServiceCollection"><code class="docutils literal notranslate"><span class="pre">ServiceCollection</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection.ServiceCollection.add_db_context"><code class="docutils literal notranslate"><span class="pre">ServiceCollection.add_db_context()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection.ServiceCollection.add_logging"><code class="docutils literal notranslate"><span class="pre">ServiceCollection.add_logging()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection.ServiceCollection.add_pipes"><code class="docutils literal notranslate"><span class="pre">ServiceCollection.add_pipes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection.ServiceCollection.add_scoped"><code class="docutils literal notranslate"><span class="pre">ServiceCollection.add_scoped()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection.ServiceCollection.add_singleton"><code class="docutils literal notranslate"><span class="pre">ServiceCollection.add_singleton()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection.ServiceCollection.add_transient"><code class="docutils literal notranslate"><span class="pre">ServiceCollection.add_transient()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection.ServiceCollection.build_service_provider"><code class="docutils literal notranslate"><span class="pre">ServiceCollection.build_service_provider()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_collection_abc">cpl_core.dependency_injection.service_collection_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="docutils literal notranslate"><span class="pre">ServiceCollectionABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_db_context"><code class="docutils literal notranslate"><span class="pre">ServiceCollectionABC.add_db_context()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_discord"><code class="docutils literal notranslate"><span class="pre">ServiceCollectionABC.add_discord()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_logging"><code class="docutils literal notranslate"><span class="pre">ServiceCollectionABC.add_logging()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_pipes"><code class="docutils literal notranslate"><span class="pre">ServiceCollectionABC.add_pipes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped"><code class="docutils literal notranslate"><span class="pre">ServiceCollectionABC.add_scoped()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton"><code class="docutils literal notranslate"><span class="pre">ServiceCollectionABC.add_singleton()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient"><code class="docutils literal notranslate"><span class="pre">ServiceCollectionABC.add_transient()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_translation"><code class="docutils literal notranslate"><span class="pre">ServiceCollectionABC.add_translation()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.build_service_provider"><code class="docutils literal notranslate"><span class="pre">ServiceCollectionABC.build_service_provider()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_descriptor">cpl_core.dependency_injection.service_descriptor module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor"><code class="docutils literal notranslate"><span class="pre">ServiceDescriptor</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.base_type"><code class="docutils literal notranslate"><span class="pre">ServiceDescriptor.base_type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.implementation"><code class="docutils literal notranslate"><span class="pre">ServiceDescriptor.implementation</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.lifetime"><code class="docutils literal notranslate"><span class="pre">ServiceDescriptor.lifetime</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.service_type"><code class="docutils literal notranslate"><span class="pre">ServiceDescriptor.service_type</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_lifetime_enum">cpl_core.dependency_injection.service_lifetime_enum module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><code class="docutils literal notranslate"><span class="pre">ServiceLifetimeEnum</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.scoped"><code class="docutils literal notranslate"><span class="pre">ServiceLifetimeEnum.scoped</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.singleton"><code class="docutils literal notranslate"><span class="pre">ServiceLifetimeEnum.singleton</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.transient"><code class="docutils literal notranslate"><span class="pre">ServiceLifetimeEnum.transient</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_provider">cpl_core.dependency_injection.service_provider module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider.ServiceProvider"><code class="docutils literal notranslate"><span class="pre">ServiceProvider</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider.ServiceProvider.build_by_signature"><code class="docutils literal notranslate"><span class="pre">ServiceProvider.build_by_signature()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider.ServiceProvider.build_service"><code class="docutils literal notranslate"><span class="pre">ServiceProvider.build_service()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider.ServiceProvider.create_scope"><code class="docutils literal notranslate"><span class="pre">ServiceProvider.create_scope()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider.ServiceProvider.get_service"><code class="docutils literal notranslate"><span class="pre">ServiceProvider.get_service()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider.ServiceProvider.get_services"><code class="docutils literal notranslate"><span class="pre">ServiceProvider.get_services()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider.ServiceProvider.set_scope"><code class="docutils literal notranslate"><span class="pre">ServiceProvider.set_scope()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection.service_provider_abc">cpl_core.dependency_injection.service_provider_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="docutils literal notranslate"><span class="pre">ServiceProviderABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_by_signature"><code class="docutils literal notranslate"><span class="pre">ServiceProviderABC.build_by_signature()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_service"><code class="docutils literal notranslate"><span class="pre">ServiceProviderABC.build_service()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.create_scope"><code class="docutils literal notranslate"><span class="pre">ServiceProviderABC.create_scope()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_service"><code class="docutils literal notranslate"><span class="pre">ServiceProviderABC.get_service()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_services"><code class="docutils literal notranslate"><span class="pre">ServiceProviderABC.get_services()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.inject"><code class="docutils literal notranslate"><span class="pre">ServiceProviderABC.inject()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.set_global_provider"><code class="docutils literal notranslate"><span class="pre">ServiceProviderABC.set_global_provider()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.set_scope"><code class="docutils literal notranslate"><span class="pre">ServiceProviderABC.set_scope()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html#module-cpl_core.dependency_injection">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html#module-cpl_core.environment.application_environment">cpl_core.environment.application_environment module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html#module-cpl_core.environment.application_environment_abc">cpl_core.environment.application_environment_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html#module-cpl_core.environment.environment_name_enum">cpl_core.environment.environment_name_enum module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html#module-cpl_core.environment.application_environment">cpl_core.environment.application_environment module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment.ApplicationEnvironment"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironment</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment.ApplicationEnvironment.application_name"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironment.application_name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment.ApplicationEnvironment.customer"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironment.customer</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment.ApplicationEnvironment.date_time_now"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironment.date_time_now</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment.ApplicationEnvironment.end_time"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironment.end_time</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment.ApplicationEnvironment.environment_name"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironment.environment_name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment.ApplicationEnvironment.host_name"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironment.host_name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment.ApplicationEnvironment.runtime_directory"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironment.runtime_directory</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment.ApplicationEnvironment.set_runtime_directory"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironment.set_runtime_directory()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment.ApplicationEnvironment.set_working_directory"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironment.set_working_directory()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment.ApplicationEnvironment.start_time"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironment.start_time</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment.ApplicationEnvironment.working_directory"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironment.working_directory</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html#module-cpl_core.environment.application_environment_abc">cpl_core.environment.application_environment_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironmentABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.application_name"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironmentABC.application_name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.customer"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironmentABC.customer</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.date_time_now"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironmentABC.date_time_now</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.end_time"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironmentABC.end_time</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.environment_name"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironmentABC.environment_name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.host_name"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironmentABC.host_name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.runtime_directory"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironmentABC.runtime_directory</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.set_runtime_directory"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironmentABC.set_runtime_directory()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.set_working_directory"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironmentABC.set_working_directory()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.start_time"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironmentABC.start_time</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC.working_directory"><code class="docutils literal notranslate"><span class="pre">ApplicationEnvironmentABC.working_directory</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html#module-cpl_core.environment.environment_name_enum">cpl_core.environment.environment_name_enum module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.environment_name_enum.EnvironmentNameEnum"><code class="docutils literal notranslate"><span class="pre">EnvironmentNameEnum</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.environment_name_enum.EnvironmentNameEnum.development"><code class="docutils literal notranslate"><span class="pre">EnvironmentNameEnum.development</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.environment_name_enum.EnvironmentNameEnum.production"><code class="docutils literal notranslate"><span class="pre">EnvironmentNameEnum.production</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.environment_name_enum.EnvironmentNameEnum.staging"><code class="docutils literal notranslate"><span class="pre">EnvironmentNameEnum.staging</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.environment_name_enum.EnvironmentNameEnum.testing"><code class="docutils literal notranslate"><span class="pre">EnvironmentNameEnum.testing</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html#module-cpl_core.environment">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.environment.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.logging.html">cpl_core.logging package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html#module-cpl_core.logging.logger_abc">cpl_core.logging.logger_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html#module-cpl_core.logging.logger_service">cpl_core.logging.logger_service module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html#module-cpl_core.logging.logging_level_enum">cpl_core.logging.logging_level_enum module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html#module-cpl_core.logging.logging_settings">cpl_core.logging.logging_settings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html#module-cpl_core.logging.logging_settings_name_enum">cpl_core.logging.logging_settings_name_enum module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html#module-cpl_core.logging.logger_abc">cpl_core.logging.logger_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_abc.LoggerABC"><code class="docutils literal notranslate"><span class="pre">LoggerABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_abc.LoggerABC.debug"><code class="docutils literal notranslate"><span class="pre">LoggerABC.debug()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_abc.LoggerABC.error"><code class="docutils literal notranslate"><span class="pre">LoggerABC.error()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_abc.LoggerABC.fatal"><code class="docutils literal notranslate"><span class="pre">LoggerABC.fatal()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_abc.LoggerABC.header"><code class="docutils literal notranslate"><span class="pre">LoggerABC.header()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_abc.LoggerABC.info"><code class="docutils literal notranslate"><span class="pre">LoggerABC.info()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_abc.LoggerABC.trace"><code class="docutils literal notranslate"><span class="pre">LoggerABC.trace()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_abc.LoggerABC.warn"><code class="docutils literal notranslate"><span class="pre">LoggerABC.warn()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html#module-cpl_core.logging.logger_service">cpl_core.logging.logger_service module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_service.Logger"><code class="docutils literal notranslate"><span class="pre">Logger</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_service.Logger.create"><code class="docutils literal notranslate"><span class="pre">Logger.create()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_service.Logger.debug"><code class="docutils literal notranslate"><span class="pre">Logger.debug()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_service.Logger.error"><code class="docutils literal notranslate"><span class="pre">Logger.error()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_service.Logger.fatal"><code class="docutils literal notranslate"><span class="pre">Logger.fatal()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_service.Logger.header"><code class="docutils literal notranslate"><span class="pre">Logger.header()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_service.Logger.info"><code class="docutils literal notranslate"><span class="pre">Logger.info()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_service.Logger.trace"><code class="docutils literal notranslate"><span class="pre">Logger.trace()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_service.Logger.warn"><code class="docutils literal notranslate"><span class="pre">Logger.warn()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html#module-cpl_core.logging.logging_level_enum">cpl_core.logging.logging_level_enum module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_level_enum.LoggingLevelEnum"><code class="docutils literal notranslate"><span class="pre">LoggingLevelEnum</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_level_enum.LoggingLevelEnum.DEBUG"><code class="docutils literal notranslate"><span class="pre">LoggingLevelEnum.DEBUG</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_level_enum.LoggingLevelEnum.ERROR"><code class="docutils literal notranslate"><span class="pre">LoggingLevelEnum.ERROR</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_level_enum.LoggingLevelEnum.FATAL"><code class="docutils literal notranslate"><span class="pre">LoggingLevelEnum.FATAL</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_level_enum.LoggingLevelEnum.INFO"><code class="docutils literal notranslate"><span class="pre">LoggingLevelEnum.INFO</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_level_enum.LoggingLevelEnum.OFF"><code class="docutils literal notranslate"><span class="pre">LoggingLevelEnum.OFF</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_level_enum.LoggingLevelEnum.TRACE"><code class="docutils literal notranslate"><span class="pre">LoggingLevelEnum.TRACE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_level_enum.LoggingLevelEnum.WARN"><code class="docutils literal notranslate"><span class="pre">LoggingLevelEnum.WARN</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html#module-cpl_core.logging.logging_settings">cpl_core.logging.logging_settings module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_settings.LoggingSettings"><code class="docutils literal notranslate"><span class="pre">LoggingSettings</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_settings.LoggingSettings.console"><code class="docutils literal notranslate"><span class="pre">LoggingSettings.console</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_settings.LoggingSettings.filename"><code class="docutils literal notranslate"><span class="pre">LoggingSettings.filename</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_settings.LoggingSettings.level"><code class="docutils literal notranslate"><span class="pre">LoggingSettings.level</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_settings.LoggingSettings.path"><code class="docutils literal notranslate"><span class="pre">LoggingSettings.path</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html#module-cpl_core.logging.logging_settings_name_enum">cpl_core.logging.logging_settings_name_enum module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">LoggingSettingsNameEnum</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum.console_level"><code class="docutils literal notranslate"><span class="pre">LoggingSettingsNameEnum.console_level</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum.file_level"><code class="docutils literal notranslate"><span class="pre">LoggingSettingsNameEnum.file_level</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum.filename"><code class="docutils literal notranslate"><span class="pre">LoggingSettingsNameEnum.filename</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum.path"><code class="docutils literal notranslate"><span class="pre">LoggingSettingsNameEnum.path</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html#module-cpl_core.logging">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.logging.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.mailing.html">cpl_core.mailing package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html#module-cpl_core.mailing.email">cpl_core.mailing.email module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html#module-cpl_core.mailing.email_client_abc">cpl_core.mailing.email_client_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html#module-cpl_core.mailing.email_client_service">cpl_core.mailing.email_client_service module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html#module-cpl_core.mailing.email_client_settings">cpl_core.mailing.email_client_settings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html#module-cpl_core.mailing.email_client_settings_name_enum">cpl_core.mailing.email_client_settings_name_enum module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html#module-cpl_core.mailing.email">cpl_core.mailing.email module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email.EMail"><code class="docutils literal notranslate"><span class="pre">EMail</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email.EMail.add_header"><code class="docutils literal notranslate"><span class="pre">EMail.add_header()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email.EMail.add_receiver"><code class="docutils literal notranslate"><span class="pre">EMail.add_receiver()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email.EMail.body"><code class="docutils literal notranslate"><span class="pre">EMail.body</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email.EMail.check_mail"><code class="docutils literal notranslate"><span class="pre">EMail.check_mail()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email.EMail.get_content"><code class="docutils literal notranslate"><span class="pre">EMail.get_content()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email.EMail.header"><code class="docutils literal notranslate"><span class="pre">EMail.header</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email.EMail.header_list"><code class="docutils literal notranslate"><span class="pre">EMail.header_list</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email.EMail.receiver"><code class="docutils literal notranslate"><span class="pre">EMail.receiver</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email.EMail.receiver_list"><code class="docutils literal notranslate"><span class="pre">EMail.receiver_list</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email.EMail.subject"><code class="docutils literal notranslate"><span class="pre">EMail.subject</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email.EMail.transceiver"><code class="docutils literal notranslate"><span class="pre">EMail.transceiver</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html#module-cpl_core.mailing.email_client_abc">cpl_core.mailing.email_client_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email_client_abc.EMailClientABC"><code class="docutils literal notranslate"><span class="pre">EMailClientABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email_client_abc.EMailClientABC.connect"><code class="docutils literal notranslate"><span class="pre">EMailClientABC.connect()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email_client_abc.EMailClientABC.send_mail"><code class="docutils literal notranslate"><span class="pre">EMailClientABC.send_mail()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html#module-cpl_core.mailing.email_client_service">cpl_core.mailing.email_client_service module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email_client_service.EMailClient"><code class="docutils literal notranslate"><span class="pre">EMailClient</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email_client_service.EMailClient.connect"><code class="docutils literal notranslate"><span class="pre">EMailClient.connect()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email_client_service.EMailClient.create"><code class="docutils literal notranslate"><span class="pre">EMailClient.create()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email_client_service.EMailClient.login"><code class="docutils literal notranslate"><span class="pre">EMailClient.login()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email_client_service.EMailClient.send_mail"><code class="docutils literal notranslate"><span class="pre">EMailClient.send_mail()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html#module-cpl_core.mailing.email_client_settings">cpl_core.mailing.email_client_settings module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email_client_settings.EMailClientSettings"><code class="docutils literal notranslate"><span class="pre">EMailClientSettings</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email_client_settings.EMailClientSettings.credentials"><code class="docutils literal notranslate"><span class="pre">EMailClientSettings.credentials</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email_client_settings.EMailClientSettings.host"><code class="docutils literal notranslate"><span class="pre">EMailClientSettings.host</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email_client_settings.EMailClientSettings.port"><code class="docutils literal notranslate"><span class="pre">EMailClientSettings.port</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email_client_settings.EMailClientSettings.user_name"><code class="docutils literal notranslate"><span class="pre">EMailClientSettings.user_name</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html#module-cpl_core.mailing.email_client_settings_name_enum">cpl_core.mailing.email_client_settings_name_enum module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">EMailClientSettingsNameEnum</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.credentials"><code class="docutils literal notranslate"><span class="pre">EMailClientSettingsNameEnum.credentials</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.host"><code class="docutils literal notranslate"><span class="pre">EMailClientSettingsNameEnum.host</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.port"><code class="docutils literal notranslate"><span class="pre">EMailClientSettingsNameEnum.port</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.user_name"><code class="docutils literal notranslate"><span class="pre">EMailClientSettingsNameEnum.user_name</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html#module-cpl_core.mailing">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.mailing.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.mailing.html#cpl_core.mailing.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.bool_pipe">cpl_core.pipes.bool_pipe module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.first_char_to_lower_pipe">cpl_core.pipes.first_char_to_lower_pipe module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.first_to_upper_pipe">cpl_core.pipes.first_to_upper_pipe module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.ip_address_pipe">cpl_core.pipes.ip_address_pipe module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.pipe_abc">cpl_core.pipes.pipe_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.to_camel_case_pipe">cpl_core.pipes.to_camel_case_pipe module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.to_snake_case_pipe">cpl_core.pipes.to_snake_case_pipe module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.version_pipe">cpl_core.pipes.version_pipe module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.bool_pipe">cpl_core.pipes.bool_pipe module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.bool_pipe.BoolPipe"><code class="docutils literal notranslate"><span class="pre">BoolPipe</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.bool_pipe.BoolPipe.transform"><code class="docutils literal notranslate"><span class="pre">BoolPipe.transform()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.first_char_to_lower_pipe">cpl_core.pipes.first_char_to_lower_pipe module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe"><code class="docutils literal notranslate"><span class="pre">FirstCharToLowerPipe</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe.transform"><code class="docutils literal notranslate"><span class="pre">FirstCharToLowerPipe.transform()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.first_to_upper_pipe">cpl_core.pipes.first_to_upper_pipe module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.first_to_upper_pipe.FirstToUpperPipe"><code class="docutils literal notranslate"><span class="pre">FirstToUpperPipe</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.first_to_upper_pipe.FirstToUpperPipe.transform"><code class="docutils literal notranslate"><span class="pre">FirstToUpperPipe.transform()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.ip_address_pipe">cpl_core.pipes.ip_address_pipe module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.ip_address_pipe.IPAddressPipe"><code class="docutils literal notranslate"><span class="pre">IPAddressPipe</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.ip_address_pipe.IPAddressPipe.transform"><code class="docutils literal notranslate"><span class="pre">IPAddressPipe.transform()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.pipe_abc">cpl_core.pipes.pipe_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.pipe_abc.PipeABC"><code class="docutils literal notranslate"><span class="pre">PipeABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.pipe_abc.PipeABC.transform"><code class="docutils literal notranslate"><span class="pre">PipeABC.transform()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.to_camel_case_pipe">cpl_core.pipes.to_camel_case_pipe module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.to_camel_case_pipe.ToCamelCasePipe"><code class="docutils literal notranslate"><span class="pre">ToCamelCasePipe</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.to_camel_case_pipe.ToCamelCasePipe.transform"><code class="docutils literal notranslate"><span class="pre">ToCamelCasePipe.transform()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.to_snake_case_pipe">cpl_core.pipes.to_snake_case_pipe module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.to_snake_case_pipe.ToSnakeCasePipe"><code class="docutils literal notranslate"><span class="pre">ToSnakeCasePipe</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.to_snake_case_pipe.ToSnakeCasePipe.transform"><code class="docutils literal notranslate"><span class="pre">ToSnakeCasePipe.transform()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.version_pipe">cpl_core.pipes.version_pipe module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.version_pipe.VersionPipe"><code class="docutils literal notranslate"><span class="pre">VersionPipe</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.version_pipe.VersionPipe.transform"><code class="docutils literal notranslate"><span class="pre">VersionPipe.transform()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl_core.pipes.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.time.html">cpl_core.time package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html#module-cpl_core.time.time_format_settings">cpl_core.time.time_format_settings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html#module-cpl_core.time.time_format_settings_names_enum">cpl_core.time.time_format_settings_names_enum module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html#module-cpl_core.time.time_format_settings">cpl_core.time.time_format_settings module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.time.html#cpl_core.time.time_format_settings.TimeFormatSettings"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettings</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.time.html#cpl_core.time.time_format_settings.TimeFormatSettings.date_format"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettings.date_format</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.time.html#cpl_core.time.time_format_settings.TimeFormatSettings.date_time_format"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettings.date_time_format</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.time.html#cpl_core.time.time_format_settings.TimeFormatSettings.date_time_log_format"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettings.date_time_log_format</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.time.html#cpl_core.time.time_format_settings.TimeFormatSettings.time_format"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettings.time_format</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html#module-cpl_core.time.time_format_settings_names_enum">cpl_core.time.time_format_settings_names_enum module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.time.html#cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettingsNamesEnum</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.time.html#cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.date_format"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettingsNamesEnum.date_format</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.time.html#cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.date_time_format"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettingsNamesEnum.date_time_format</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.time.html#cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.date_time_log_format"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettingsNamesEnum.date_time_log_format</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.time.html#cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum.time_format"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettingsNamesEnum.time_format</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html#module-cpl_core.time">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.time.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.time.html#cpl_core.time.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.time.html#cpl_core.time.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.time.html#cpl_core.time.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.time.html#cpl_core.time.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html#module-cpl_core.utils.credential_manager">cpl_core.utils.credential_manager module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html#module-cpl_core.utils.pip">cpl_core.utils.pip module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html#module-cpl_core.utils.string">cpl_core.utils.string module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html#module-cpl_core.utils.credential_manager">cpl_core.utils.credential_manager module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.credential_manager.CredentialManager"><code class="docutils literal notranslate"><span class="pre">CredentialManager</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.credential_manager.CredentialManager.build_string"><code class="docutils literal notranslate"><span class="pre">CredentialManager.build_string()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.credential_manager.CredentialManager.decrypt"><code class="docutils literal notranslate"><span class="pre">CredentialManager.decrypt()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.credential_manager.CredentialManager.encrypt"><code class="docutils literal notranslate"><span class="pre">CredentialManager.encrypt()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html#module-cpl_core.utils.pip">cpl_core.utils.pip module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.pip.Pip"><code class="docutils literal notranslate"><span class="pre">Pip</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.pip.Pip.get_executable"><code class="docutils literal notranslate"><span class="pre">Pip.get_executable()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.pip.Pip.get_outdated"><code class="docutils literal notranslate"><span class="pre">Pip.get_outdated()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.pip.Pip.get_package"><code class="docutils literal notranslate"><span class="pre">Pip.get_package()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.pip.Pip.install"><code class="docutils literal notranslate"><span class="pre">Pip.install()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.pip.Pip.reset_executable"><code class="docutils literal notranslate"><span class="pre">Pip.reset_executable()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.pip.Pip.set_executable"><code class="docutils literal notranslate"><span class="pre">Pip.set_executable()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.pip.Pip.uninstall"><code class="docutils literal notranslate"><span class="pre">Pip.uninstall()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html#module-cpl_core.utils.string">cpl_core.utils.string module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.string.String"><code class="docutils literal notranslate"><span class="pre">String</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.string.String.convert_to_camel_case"><code class="docutils literal notranslate"><span class="pre">String.convert_to_camel_case()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.string.String.convert_to_snake_case"><code class="docutils literal notranslate"><span class="pre">String.convert_to_snake_case()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.string.String.first_to_lower"><code class="docutils literal notranslate"><span class="pre">String.first_to_lower()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.string.String.first_to_upper"><code class="docutils literal notranslate"><span class="pre">String.first_to_upper()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.string.String.random_string"><code class="docutils literal notranslate"><span class="pre">String.random_string()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html#module-cpl_core.utils">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.utils.html#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.utils.html#cpl_core.utils.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_core.logging package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
@@ -52,13 +57,29 @@
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.logging package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.logging.logger_abc">cpl_core.logging.logger_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.logging.logger_service">cpl_core.logging.logger_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.logging.logging_level_enum">cpl_core.logging.logging_level_enum module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.logging.logging_settings">cpl_core.logging.logging_settings module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.logging.logging_settings_name_enum">cpl_core.logging.logging_settings_name_enum module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.logging.logger_abc">cpl_core.logging.logger_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.logging.logger_abc.LoggerABC"><code class="docutils literal notranslate"><span class="pre">LoggerABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.logging.logger_service">cpl_core.logging.logger_service module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.logging.logger_service.Logger"><code class="docutils literal notranslate"><span class="pre">Logger</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.logging.logging_level_enum">cpl_core.logging.logging_level_enum module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.logging.logging_level_enum.LoggingLevelEnum"><code class="docutils literal notranslate"><span class="pre">LoggingLevelEnum</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.logging.logging_settings">cpl_core.logging.logging_settings module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.logging.logging_settings.LoggingSettings"><code class="docutils literal notranslate"><span class="pre">LoggingSettings</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.logging.logging_settings_name_enum">cpl_core.logging.logging_settings_name_enum module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">LoggingSettingsNameEnum</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.logging">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.logging.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -87,9 +108,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_core.html">API reference</a> &raquo;</li>
<li>cpl_core.logging package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
<li class="breadcrumb-item active">cpl_core.logging package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.logging.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -128,7 +149,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.logging.logger_abc.LoggerABC.error">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Exception</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_abc.LoggerABC.error" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Exception</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_abc.LoggerABC.error" title="Permalink to this definition"></a></dt>
<dd><p>Writes an error</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -145,7 +166,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.logging.logger_abc.LoggerABC.fatal">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fatal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Exception</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_abc.LoggerABC.fatal" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fatal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Exception</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_abc.LoggerABC.fatal" title="Permalink to this definition"></a></dt>
<dd><p>Writes an error and ends the program</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -262,7 +283,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.logging.logger_service.Logger.error">
<span class="sig-name descname"><span class="pre">error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Exception</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_service.Logger.error" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Exception</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_service.Logger.error" title="Permalink to this definition"></a></dt>
<dd><p>Writes an error</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -279,7 +300,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.logging.logger_service.Logger.fatal">
<span class="sig-name descname"><span class="pre">fatal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Exception</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_service.Logger.fatal" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">fatal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Exception</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_service.Logger.fatal" title="Permalink to this definition"></a></dt>
<dd><p>Writes an error and ends the program</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -404,7 +425,7 @@
<span id="cpl-core-logging-logging-settings-module"></span><h2>cpl_core.logging.logging_settings module<a class="headerlink" href="#module-cpl_core.logging.logging_settings" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.logging.logging_settings.LoggingSettings">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.logging.logging_settings.</span></span><span class="sig-name descname"><span class="pre">LoggingSettings</span></span><a class="headerlink" href="#cpl_core.logging.logging_settings.LoggingSettings" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.logging.logging_settings.</span></span><span class="sig-name descname"><span class="pre">LoggingSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">console_log_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.logging.logging_level_enum.LoggingLevelEnum" title="cpl_core.logging.logging_level_enum.LoggingLevelEnum"><span class="pre">LoggingLevelEnum</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_log_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.logging.logging_level_enum.LoggingLevelEnum" title="cpl_core.logging.logging_level_enum.LoggingLevelEnum"><span class="pre">LoggingLevelEnum</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logging_settings.LoggingSettings" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
<p>Representation of logging settings</p>
<dl class="py property">
@@ -417,16 +438,6 @@
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">filename</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.logging.logging_settings.LoggingSettings.filename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.logging.logging_settings.LoggingSettings.from_dict">
<span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logging_settings.LoggingSettings.from_dict" title="Permalink to this definition"></a></dt>
<dd><p>Converts attributes to dict</p>
<dl class="simple">
<dt>Parameter:</dt><dd><p>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.logging.logging_settings.LoggingSettings.level">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">level</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.logging.logging_level_enum.LoggingLevelEnum" title="cpl_core.logging.logging_level_enum.LoggingLevelEnum"><span class="pre">LoggingLevelEnum</span></a></em><a class="headerlink" href="#cpl_core.logging.logging_settings.LoggingSettings.level" title="Permalink to this definition"></a></dt>
@@ -476,15 +487,16 @@
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
<p>CPL core package</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2020 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.logging.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.logging.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -509,7 +521,6 @@
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_core.mailing package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
@@ -53,13 +58,29 @@
<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html">cpl_core.logging package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.mailing package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email">cpl_core.mailing.email module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email_client_abc">cpl_core.mailing.email_client_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email_client_service">cpl_core.mailing.email_client_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email_client_settings">cpl_core.mailing.email_client_settings module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email_client_settings_name_enum">cpl_core.mailing.email_client_settings_name_enum module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email">cpl_core.mailing.email module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.mailing.email.EMail"><code class="docutils literal notranslate"><span class="pre">EMail</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email_client_abc">cpl_core.mailing.email_client_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.mailing.email_client_abc.EMailClientABC"><code class="docutils literal notranslate"><span class="pre">EMailClientABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email_client_service">cpl_core.mailing.email_client_service module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.mailing.email_client_service.EMailClient"><code class="docutils literal notranslate"><span class="pre">EMailClient</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email_client_settings">cpl_core.mailing.email_client_settings module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.mailing.email_client_settings.EMailClientSettings"><code class="docutils literal notranslate"><span class="pre">EMailClientSettings</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email_client_settings_name_enum">cpl_core.mailing.email_client_settings_name_enum module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">EMailClientSettingsNameEnum</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.mailing.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -87,9 +108,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_core.html">API reference</a> &raquo;</li>
<li>cpl_core.mailing package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
<li class="breadcrumb-item active">cpl_core.mailing package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.mailing.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -108,7 +129,7 @@
<span id="cpl-core-mailing-email-module"></span><h2>cpl_core.mailing.email module<a class="headerlink" href="#module-cpl_core.mailing.email" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.mailing.email.EMail">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.mailing.email.</span></span><span class="sig-name descname"><span class="pre">EMail</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">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">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transceiver</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">receiver</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">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">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.mailing.email.EMail" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.mailing.email.</span></span><span class="sig-name descname"><span class="pre">EMail</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transceiver</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">receiver</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.mailing.email.EMail" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Represents an email</p>
<dl class="simple">
@@ -305,7 +326,7 @@
<span id="cpl-core-mailing-email-client-settings-module"></span><h2>cpl_core.mailing.email_client_settings module<a class="headerlink" href="#module-cpl_core.mailing.email_client_settings" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.mailing.email_client_settings.EMailClientSettings">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.mailing.email_client_settings.</span></span><span class="sig-name descname"><span class="pre">EMailClientSettings</span></span><a class="headerlink" href="#cpl_core.mailing.email_client_settings.EMailClientSettings" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.mailing.email_client_settings.</span></span><span class="sig-name descname"><span class="pre">EMailClientSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.mailing.email_client_settings.EMailClientSettings" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
<p>Representation of mailing settings</p>
<dl class="py property">
@@ -313,16 +334,6 @@
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">credentials</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.mailing.email_client_settings.EMailClientSettings.credentials" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.mailing.email_client_settings.EMailClientSettings.from_dict">
<span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.mailing.email_client_settings.EMailClientSettings.from_dict" title="Permalink to this definition"></a></dt>
<dd><p>Converts attributes to dict</p>
<dl class="simple">
<dt>Parameter:</dt><dd><p>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.mailing.email_client_settings.EMailClientSettings.host">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.mailing.email_client_settings.EMailClientSettings.host" title="Permalink to this definition"></a></dt>
@@ -377,15 +388,16 @@
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
<p>CPL core package</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2020 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.mailing.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.mailing.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.mailing.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -410,7 +422,6 @@
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_core.pipes package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
@@ -54,16 +59,41 @@
<li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html">cpl_core.mailing package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.pipes package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.bool_pipe">cpl_core.pipes.bool_pipe module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.first_char_to_lower_pipe">cpl_core.pipes.first_char_to_lower_pipe module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.first_to_upper_pipe">cpl_core.pipes.first_to_upper_pipe module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.ip_address_pipe">cpl_core.pipes.ip_address_pipe module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.pipe_abc">cpl_core.pipes.pipe_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.to_camel_case_pipe">cpl_core.pipes.to_camel_case_pipe module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.to_snake_case_pipe">cpl_core.pipes.to_snake_case_pipe module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.version_pipe">cpl_core.pipes.version_pipe module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.bool_pipe">cpl_core.pipes.bool_pipe module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.pipes.bool_pipe.BoolPipe"><code class="docutils literal notranslate"><span class="pre">BoolPipe</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.first_char_to_lower_pipe">cpl_core.pipes.first_char_to_lower_pipe module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe"><code class="docutils literal notranslate"><span class="pre">FirstCharToLowerPipe</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.first_to_upper_pipe">cpl_core.pipes.first_to_upper_pipe module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.pipes.first_to_upper_pipe.FirstToUpperPipe"><code class="docutils literal notranslate"><span class="pre">FirstToUpperPipe</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.ip_address_pipe">cpl_core.pipes.ip_address_pipe module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.pipes.ip_address_pipe.IPAddressPipe"><code class="docutils literal notranslate"><span class="pre">IPAddressPipe</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.pipe_abc">cpl_core.pipes.pipe_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.pipes.pipe_abc.PipeABC"><code class="docutils literal notranslate"><span class="pre">PipeABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.to_camel_case_pipe">cpl_core.pipes.to_camel_case_pipe module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.pipes.to_camel_case_pipe.ToCamelCasePipe"><code class="docutils literal notranslate"><span class="pre">ToCamelCasePipe</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.to_snake_case_pipe">cpl_core.pipes.to_snake_case_pipe module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.pipes.to_snake_case_pipe.ToSnakeCasePipe"><code class="docutils literal notranslate"><span class="pre">ToSnakeCasePipe</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.version_pipe">cpl_core.pipes.version_pipe module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.pipes.version_pipe.VersionPipe"><code class="docutils literal notranslate"><span class="pre">VersionPipe</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.pipes.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -90,9 +120,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_core.html">API reference</a> &raquo;</li>
<li>cpl_core.pipes package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
<li class="breadcrumb-item active">cpl_core.pipes package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.pipes.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -265,15 +295,16 @@
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
<p>CPL core package</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2020 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.pipes.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.pipes.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -298,7 +329,6 @@
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_core.time package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
@@ -55,10 +60,17 @@
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.time package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.time.time_format_settings">cpl_core.time.time_format_settings module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.time.time_format_settings_names_enum">cpl_core.time.time_format_settings_names_enum module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.time.time_format_settings">cpl_core.time.time_format_settings module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.time.time_format_settings.TimeFormatSettings"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettings</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.time.time_format_settings_names_enum">cpl_core.time.time_format_settings_names_enum module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum"><code class="docutils literal notranslate"><span class="pre">TimeFormatSettingsNamesEnum</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.time">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.time.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -84,9 +96,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_core.html">API reference</a> &raquo;</li>
<li>cpl_core.time package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
<li class="breadcrumb-item active">cpl_core.time package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.time.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -105,7 +117,7 @@
<span id="cpl-core-time-time-format-settings-module"></span><h2>cpl_core.time.time_format_settings module<a class="headerlink" href="#module-cpl_core.time.time_format_settings" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.time.time_format_settings.TimeFormatSettings">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.time.time_format_settings.</span></span><span class="sig-name descname"><span class="pre">TimeFormatSettings</span></span><a class="headerlink" href="#cpl_core.time.time_format_settings.TimeFormatSettings" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.time.time_format_settings.</span></span><span class="sig-name descname"><span class="pre">TimeFormatSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">time_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">date_time_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">date_time_log_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.time.time_format_settings.TimeFormatSettings" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
<p>Representation of time format settings</p>
<dl class="py property">
@@ -123,16 +135,6 @@
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date_time_log_format</span></span><a class="headerlink" href="#cpl_core.time.time_format_settings.TimeFormatSettings.date_time_log_format" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.time.time_format_settings.TimeFormatSettings.from_dict">
<span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.time.time_format_settings.TimeFormatSettings.from_dict" title="Permalink to this definition"></a></dt>
<dd><p>Converts attributes to dict</p>
<dl class="simple">
<dt>Parameter:</dt><dd><p>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.time.time_format_settings.TimeFormatSettings.time_format">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">time_format</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.time.time_format_settings.TimeFormatSettings.time_format" title="Permalink to this definition"></a></dt>
@@ -177,15 +179,16 @@
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
<p>CPL core package</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2020 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.time.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.time.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.time.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -210,7 +213,6 @@
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_core.utils package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
@@ -56,11 +61,21 @@
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.utils package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.utils.credential_manager">cpl_core.utils.credential_manager module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.utils.pip">cpl_core.utils.pip module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.utils.string">cpl_core.utils.string module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.utils.credential_manager">cpl_core.utils.credential_manager module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.utils.credential_manager.CredentialManager"><code class="docutils literal notranslate"><span class="pre">CredentialManager</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.utils.pip">cpl_core.utils.pip module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.utils.pip.Pip"><code class="docutils literal notranslate"><span class="pre">Pip</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.utils.string">cpl_core.utils.string module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.utils.string.String"><code class="docutils literal notranslate"><span class="pre">String</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.utils">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.utils.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -85,9 +100,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_core.html">API reference</a> &raquo;</li>
<li>cpl_core.utils package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
<li class="breadcrumb-item active">cpl_core.utils package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.utils.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -183,7 +198,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.utils.pip.Pip.get_package">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_package</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><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><a class="headerlink" href="#cpl_core.utils.pip.Pip.get_package" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_package</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_core.utils.pip.Pip.get_package" title="Permalink to this definition"></a></dt>
<dd><p>Gets given package py local pip list</p>
<dl class="simple">
<dt>Parameter:</dt><dd><p>package: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
@@ -195,7 +210,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.utils.pip.Pip.install">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">install</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stdout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stderr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.utils.pip.Pip.install" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">install</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stdout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stderr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.utils.pip.Pip.install" title="Permalink to this definition"></a></dt>
<dd><p>Installs given package</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -339,15 +354,16 @@
<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
<p>CPL core package</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2020 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_core.utils.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.utils.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.utils.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -372,7 +388,6 @@
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_discord.application package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,14 +46,19 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord Reference</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_discord.application package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.application.discord_bot_application_abc">cpl_discord.application.discord_bot_application_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.application.discord_bot_application_abc">cpl_discord.application.discord_bot_application_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.application.discord_bot_application_abc.DiscordBotApplicationABC"><code class="docutils literal notranslate"><span class="pre">DiscordBotApplicationABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.application">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-discord-cpl-discord">cpl-discord CPL Discord</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.application.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -80,9 +89,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_discord.html">Discord Reference</a> &raquo;</li>
<li>cpl_discord.application package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_discord.html">Discord Reference</a></li>
<li class="breadcrumb-item active">cpl_discord.application package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_discord.application.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -117,15 +126,16 @@
<h3>cpl-discord CPL Discord<a class="headerlink" href="#cpl-discord-cpl-discord" title="Permalink to this heading"></a></h3>
<p>Link between discord.py and CPL</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2022 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_discord.application.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.application.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.application.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -150,7 +160,6 @@
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_discord.command package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,16 +46,24 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_discord.command package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.command.discord_command_abc">cpl_discord.command.discord_command_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.command.discord_commands_meta">cpl_discord.command.discord_commands_meta module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.command.discord_command_abc">cpl_discord.command.discord_command_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.command.discord_command_abc.DiscordCommandABC"><code class="docutils literal notranslate"><span class="pre">DiscordCommandABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.command.discord_commands_meta">cpl_discord.command.discord_commands_meta module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.command.discord_commands_meta.DiscordCogMeta"><code class="docutils literal notranslate"><span class="pre">DiscordCogMeta</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.command">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-discord-cpl-discord">cpl-discord CPL Discord</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.command.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -81,9 +93,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_discord.html">Discord Reference</a> &raquo;</li>
<li>cpl_discord.command package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_discord.html">Discord Reference</a></li>
<li class="breadcrumb-item active">cpl_discord.command package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_discord.command.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -122,15 +134,16 @@
<h3>cpl-discord CPL Discord<a class="headerlink" href="#cpl-discord-cpl-discord" title="Permalink to this heading"></a></h3>
<p>Link between discord.py and CPL</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2022 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_discord.command.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.command.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.command.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -155,7 +168,6 @@
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_discord.configuration package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord Reference</a><ul class="current">
@@ -49,9 +54,13 @@
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html">cpl_discord.command package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_discord.configuration package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.configuration.discord_bot_settings">cpl_discord.configuration.discord_bot_settings module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.configuration.discord_bot_settings">cpl_discord.configuration.discord_bot_settings module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.configuration.discord_bot_settings.DiscordBotSettings"><code class="docutils literal notranslate"><span class="pre">DiscordBotSettings</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.configuration">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-discord-cpl-discord">cpl-discord CPL Discord</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.configuration.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -80,9 +89,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_discord.html">Discord Reference</a> &raquo;</li>
<li>cpl_discord.configuration package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_discord.html">Discord Reference</a></li>
<li class="breadcrumb-item active">cpl_discord.configuration package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_discord.configuration.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -101,18 +110,8 @@
<span id="cpl-discord-configuration-discord-bot-settings-module"></span><h2>cpl_discord.configuration.discord_bot_settings module<a class="headerlink" href="#module-cpl_discord.configuration.discord_bot_settings" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_discord.configuration.discord_bot_settings.DiscordBotSettings">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.configuration.discord_bot_settings.</span></span><span class="sig-name descname"><span class="pre">DiscordBotSettings</span></span><a class="headerlink" href="#cpl_discord.configuration.discord_bot_settings.DiscordBotSettings" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.configuration.discord_bot_settings.</span></span><span class="sig-name descname"><span class="pre">DiscordBotSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.configuration.discord_bot_settings.DiscordBotSettings" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_discord.configuration.discord_bot_settings.DiscordBotSettings.from_dict">
<span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.configuration.discord_bot_settings.DiscordBotSettings.from_dict" title="Permalink to this definition"></a></dt>
<dd><p>Converts attributes to dict</p>
<dl class="simple">
<dt>Parameter:</dt><dd><p>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_discord.configuration.discord_bot_settings.DiscordBotSettings.prefix">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">prefix</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_discord.configuration.discord_bot_settings.DiscordBotSettings.prefix" title="Permalink to this definition"></a></dt>
@@ -132,15 +131,16 @@
<h3>cpl-discord CPL Discord<a class="headerlink" href="#cpl-discord-cpl-discord" title="Permalink to this heading"></a></h3>
<p>Link between discord.py and CPL</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2022 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_discord.configuration.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.configuration.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.configuration.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -165,7 +165,6 @@
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_discord.container package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord Reference</a><ul class="current">
@@ -50,16 +55,41 @@
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.configuration.html">cpl_discord.configuration package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_discord.container package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.category_channel">cpl_discord.container.category_channel module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.container">cpl_discord.container.container module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.guild">cpl_discord.container.guild module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.member">cpl_discord.container.member module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.role">cpl_discord.container.role module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.text_channel">cpl_discord.container.text_channel module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.thread">cpl_discord.container.thread module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.voice_channel">cpl_discord.container.voice_channel module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.category_channel">cpl_discord.container.category_channel module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.container.category_channel.CategoryChannel"><code class="docutils literal notranslate"><span class="pre">CategoryChannel</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.container">cpl_discord.container.container module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.container.container.Container"><code class="docutils literal notranslate"><span class="pre">Container</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.guild">cpl_discord.container.guild module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.container.guild.Guild"><code class="docutils literal notranslate"><span class="pre">Guild</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.member">cpl_discord.container.member module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.container.member.Member"><code class="docutils literal notranslate"><span class="pre">Member</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.role">cpl_discord.container.role module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.container.role.Role"><code class="docutils literal notranslate"><span class="pre">Role</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.text_channel">cpl_discord.container.text_channel module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.container.text_channel.TextChannel"><code class="docutils literal notranslate"><span class="pre">TextChannel</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.thread">cpl_discord.container.thread module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.container.thread.Thread"><code class="docutils literal notranslate"><span class="pre">Thread</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.voice_channel">cpl_discord.container.voice_channel module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.container.voice_channel.VoiceChannel"><code class="docutils literal notranslate"><span class="pre">VoiceChannel</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-discord-cpl-discord">cpl-discord CPL Discord</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.container.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -87,9 +117,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_discord.html">Discord Reference</a> &raquo;</li>
<li>cpl_discord.container package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_discord.html">Discord Reference</a></li>
<li class="breadcrumb-item active">cpl_discord.container package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_discord.container.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -112,7 +142,7 @@
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">CategoryChannel</span></code>, <a class="reference internal" href="#cpl_discord.container.container.Container" title="cpl_discord.container.container.Container"><code class="xref py py-class docutils literal notranslate"><span class="pre">Container</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="cpl_discord.container.category_channel.CategoryChannel.category_id">
<span class="sig-name descname"><span class="pre">category_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_discord.container.category_channel.CategoryChannel.category_id" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">category_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_discord.container.category_channel.CategoryChannel.category_id" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@@ -365,12 +395,12 @@ hierarchy.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="cpl_discord.container.member.Member.joined_at">
<span class="sig-name descname"><span class="pre">joined_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime.datetime</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_discord.container.member.Member.joined_at" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">joined_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime.datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_discord.container.member.Member.joined_at" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="cpl_discord.container.member.Member.nick">
<span class="sig-name descname"><span class="pre">nick</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_discord.container.member.Member.nick" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">nick</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_discord.container.member.Member.nick" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@@ -380,7 +410,7 @@ hierarchy.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="cpl_discord.container.member.Member.premium_since">
<span class="sig-name descname"><span class="pre">premium_since</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime.datetime</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_discord.container.member.Member.premium_since" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">premium_since</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime.datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_discord.container.member.Member.premium_since" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
@@ -394,7 +424,7 @@ role.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="cpl_discord.container.member.Member.timed_out_until">
<span class="sig-name descname"><span class="pre">timed_out_until</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime.datetime</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_discord.container.member.Member.timed_out_until" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">timed_out_until</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime.datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_discord.container.member.Member.timed_out_until" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@@ -468,7 +498,7 @@ role.</p>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">TextChannel</span></code>, <a class="reference internal" href="#cpl_discord.container.container.Container" title="cpl_discord.container.container.Container"><code class="xref py py-class docutils literal notranslate"><span class="pre">Container</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="cpl_discord.container.text_channel.TextChannel.category_id">
<span class="sig-name descname"><span class="pre">category_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_discord.container.text_channel.TextChannel.category_id" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">category_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_discord.container.text_channel.TextChannel.category_id" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@@ -653,15 +683,16 @@ needed.</p>
<h3>cpl-discord CPL Discord<a class="headerlink" href="#cpl-discord-cpl-discord" title="Permalink to this heading"></a></h3>
<p>Link between discord.py and CPL</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2022 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_discord.container.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.container.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.container.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -686,7 +717,6 @@ needed.</p>
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_discord.events package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord Reference</a><ul class="current">
@@ -51,59 +56,213 @@
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html">cpl_discord.container package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_discord.events package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_bulk_message_delete_abc">cpl_discord.events.on_bulk_message_delete_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_command_abc">cpl_discord.events.on_command_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_command_completion_abc">cpl_discord.events.on_command_completion_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_command_error_abc">cpl_discord.events.on_command_error_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_connect_abc">cpl_discord.events.on_connect_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_disconnect_abc">cpl_discord.events.on_disconnect_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_error_abc">cpl_discord.events.on_error_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_group_join_abc">cpl_discord.events.on_group_join_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_group_remove_abc">cpl_discord.events.on_group_remove_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_available_abc">cpl_discord.events.on_guild_available_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_channel_create_abc">cpl_discord.events.on_guild_channel_create_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_channel_delete_abc">cpl_discord.events.on_guild_channel_delete_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_channel_pins_update_abc">cpl_discord.events.on_guild_channel_pins_update_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_channel_update_abc">cpl_discord.events.on_guild_channel_update_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_emojis_update_abc">cpl_discord.events.on_guild_emojis_update_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_integrations_update_abc">cpl_discord.events.on_guild_integrations_update_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_join_abc">cpl_discord.events.on_guild_join_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_remove_abc">cpl_discord.events.on_guild_remove_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_role_create_abc">cpl_discord.events.on_guild_role_create_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_role_delete_abc">cpl_discord.events.on_guild_role_delete_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_role_update_abc">cpl_discord.events.on_guild_role_update_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_unavailable_abc">cpl_discord.events.on_guild_unavailable_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_update_abc">cpl_discord.events.on_guild_update_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_invite_create_abc">cpl_discord.events.on_invite_create_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_invite_delete_abc">cpl_discord.events.on_invite_delete_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_member_ban_abc">cpl_discord.events.on_member_ban_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_member_join_abc">cpl_discord.events.on_member_join_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_member_remove_abc">cpl_discord.events.on_member_remove_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_member_unban_abc">cpl_discord.events.on_member_unban_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_member_update_abc">cpl_discord.events.on_member_update_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_message_abc">cpl_discord.events.on_message_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_message_delete_abc">cpl_discord.events.on_message_delete_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_message_edit_abc">cpl_discord.events.on_message_edit_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_private_channel_create_abc">cpl_discord.events.on_private_channel_create_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_private_channel_delete_abc">cpl_discord.events.on_private_channel_delete_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_private_channel_pins_update_abc">cpl_discord.events.on_private_channel_pins_update_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_private_channel_update_abc">cpl_discord.events.on_private_channel_update_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_raw_reaction_add_abc">cpl_discord.events.on_raw_reaction_add_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_raw_reaction_clear_abc">cpl_discord.events.on_raw_reaction_clear_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_raw_reaction_clear_emoji_abc">cpl_discord.events.on_raw_reaction_clear_emoji_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_raw_reaction_remove_abc">cpl_discord.events.on_raw_reaction_remove_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_reaction_add_abc">cpl_discord.events.on_reaction_add_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_reaction_clear_abc">cpl_discord.events.on_reaction_clear_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_reaction_clear_emoji_abc">cpl_discord.events.on_reaction_clear_emoji_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_reaction_remove_abc">cpl_discord.events.on_reaction_remove_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_ready_abc">cpl_discord.events.on_ready_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_resume_abc">cpl_discord.events.on_resume_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_typing_abc">cpl_discord.events.on_typing_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_user_update_abc">cpl_discord.events.on_user_update_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_voice_state_update_abc">cpl_discord.events.on_voice_state_update_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_webhooks_update_abc">cpl_discord.events.on_webhooks_update_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_bulk_message_delete_abc">cpl_discord.events.on_bulk_message_delete_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_bulk_message_delete_abc.OnBulkMessageDeleteABC"><code class="docutils literal notranslate"><span class="pre">OnBulkMessageDeleteABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_command_abc">cpl_discord.events.on_command_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_command_abc.OnCommandABC"><code class="docutils literal notranslate"><span class="pre">OnCommandABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_command_completion_abc">cpl_discord.events.on_command_completion_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_command_completion_abc.OnCommandCompletionABC"><code class="docutils literal notranslate"><span class="pre">OnCommandCompletionABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_command_error_abc">cpl_discord.events.on_command_error_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_command_error_abc.OnCommandErrorABC"><code class="docutils literal notranslate"><span class="pre">OnCommandErrorABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_connect_abc">cpl_discord.events.on_connect_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_connect_abc.OnConnectABC"><code class="docutils literal notranslate"><span class="pre">OnConnectABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_disconnect_abc">cpl_discord.events.on_disconnect_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_disconnect_abc.OnDisconnectABC"><code class="docutils literal notranslate"><span class="pre">OnDisconnectABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_error_abc">cpl_discord.events.on_error_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_error_abc.OnErrorABC"><code class="docutils literal notranslate"><span class="pre">OnErrorABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_group_join_abc">cpl_discord.events.on_group_join_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_group_join_abc.OnGroupJoinABC"><code class="docutils literal notranslate"><span class="pre">OnGroupJoinABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_group_remove_abc">cpl_discord.events.on_group_remove_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_group_remove_abc.OnGroupRemoveABC"><code class="docutils literal notranslate"><span class="pre">OnGroupRemoveABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_available_abc">cpl_discord.events.on_guild_available_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_guild_available_abc.OnGuildAvailableABC"><code class="docutils literal notranslate"><span class="pre">OnGuildAvailableABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_channel_create_abc">cpl_discord.events.on_guild_channel_create_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_guild_channel_create_abc.OnGuildChannelCreateABC"><code class="docutils literal notranslate"><span class="pre">OnGuildChannelCreateABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_channel_delete_abc">cpl_discord.events.on_guild_channel_delete_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_guild_channel_delete_abc.OnGuildChannelDeleteABC"><code class="docutils literal notranslate"><span class="pre">OnGuildChannelDeleteABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_channel_pins_update_abc">cpl_discord.events.on_guild_channel_pins_update_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_guild_channel_pins_update_abc.OnGuildChannelPinsUpdateABC"><code class="docutils literal notranslate"><span class="pre">OnGuildChannelPinsUpdateABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_channel_update_abc">cpl_discord.events.on_guild_channel_update_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_guild_channel_update_abc.OnGuildChannelUpdateABC"><code class="docutils literal notranslate"><span class="pre">OnGuildChannelUpdateABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_emojis_update_abc">cpl_discord.events.on_guild_emojis_update_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_guild_emojis_update_abc.OnGuildEmojisUpdateABC"><code class="docutils literal notranslate"><span class="pre">OnGuildEmojisUpdateABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_integrations_update_abc">cpl_discord.events.on_guild_integrations_update_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_guild_integrations_update_abc.OnGuildIntegrationsUpdateABC"><code class="docutils literal notranslate"><span class="pre">OnGuildIntegrationsUpdateABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_join_abc">cpl_discord.events.on_guild_join_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_guild_join_abc.OnGuildJoinABC"><code class="docutils literal notranslate"><span class="pre">OnGuildJoinABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_remove_abc">cpl_discord.events.on_guild_remove_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_guild_remove_abc.OnGuildRemoveABC"><code class="docutils literal notranslate"><span class="pre">OnGuildRemoveABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_role_create_abc">cpl_discord.events.on_guild_role_create_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_guild_role_create_abc.OnGuildRoleCreateABC"><code class="docutils literal notranslate"><span class="pre">OnGuildRoleCreateABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_role_delete_abc">cpl_discord.events.on_guild_role_delete_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_guild_role_delete_abc.OnGuildRoleDeleteABC"><code class="docutils literal notranslate"><span class="pre">OnGuildRoleDeleteABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_role_update_abc">cpl_discord.events.on_guild_role_update_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_guild_role_update_abc.OnGuildRoleUpdateABC"><code class="docutils literal notranslate"><span class="pre">OnGuildRoleUpdateABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_unavailable_abc">cpl_discord.events.on_guild_unavailable_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_guild_unavailable_abc.OnGuildUnavailableABC"><code class="docutils literal notranslate"><span class="pre">OnGuildUnavailableABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_update_abc">cpl_discord.events.on_guild_update_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_guild_update_abc.OnGuildUpdateABC"><code class="docutils literal notranslate"><span class="pre">OnGuildUpdateABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_invite_create_abc">cpl_discord.events.on_invite_create_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_invite_create_abc.OnInviteCreateABC"><code class="docutils literal notranslate"><span class="pre">OnInviteCreateABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_invite_delete_abc">cpl_discord.events.on_invite_delete_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_invite_delete_abc.OnInviteDeleteABC"><code class="docutils literal notranslate"><span class="pre">OnInviteDeleteABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_member_ban_abc">cpl_discord.events.on_member_ban_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_member_ban_abc.OnMemberBanABC"><code class="docutils literal notranslate"><span class="pre">OnMemberBanABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_member_join_abc">cpl_discord.events.on_member_join_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_member_join_abc.OnMemberJoinABC"><code class="docutils literal notranslate"><span class="pre">OnMemberJoinABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_member_remove_abc">cpl_discord.events.on_member_remove_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_member_remove_abc.OnMemberRemoveABC"><code class="docutils literal notranslate"><span class="pre">OnMemberRemoveABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_member_unban_abc">cpl_discord.events.on_member_unban_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_member_unban_abc.OnMemberUnbanABC"><code class="docutils literal notranslate"><span class="pre">OnMemberUnbanABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_member_update_abc">cpl_discord.events.on_member_update_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_member_update_abc.OnMemberUpdateABC"><code class="docutils literal notranslate"><span class="pre">OnMemberUpdateABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_message_abc">cpl_discord.events.on_message_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_message_abc.OnMessageABC"><code class="docutils literal notranslate"><span class="pre">OnMessageABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_message_delete_abc">cpl_discord.events.on_message_delete_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_message_delete_abc.OnMessageDeleteABC"><code class="docutils literal notranslate"><span class="pre">OnMessageDeleteABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_message_edit_abc">cpl_discord.events.on_message_edit_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_message_edit_abc.OnMessageEditABC"><code class="docutils literal notranslate"><span class="pre">OnMessageEditABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_private_channel_create_abc">cpl_discord.events.on_private_channel_create_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_private_channel_create_abc.OnPrivateChannelCreateABC"><code class="docutils literal notranslate"><span class="pre">OnPrivateChannelCreateABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_private_channel_delete_abc">cpl_discord.events.on_private_channel_delete_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_private_channel_delete_abc.OnPrivateChannelDeleteABC"><code class="docutils literal notranslate"><span class="pre">OnPrivateChannelDeleteABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_private_channel_pins_update_abc">cpl_discord.events.on_private_channel_pins_update_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_private_channel_pins_update_abc.OnPrivateChannelPinsUpdateABC"><code class="docutils literal notranslate"><span class="pre">OnPrivateChannelPinsUpdateABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_private_channel_update_abc">cpl_discord.events.on_private_channel_update_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_private_channel_update_abc.OnPrivateChannelUpdateABC"><code class="docutils literal notranslate"><span class="pre">OnPrivateChannelUpdateABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_raw_reaction_add_abc">cpl_discord.events.on_raw_reaction_add_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_raw_reaction_add_abc.OnRawReactionAddABC"><code class="docutils literal notranslate"><span class="pre">OnRawReactionAddABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_raw_reaction_clear_abc">cpl_discord.events.on_raw_reaction_clear_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_raw_reaction_clear_abc.OnRawReactionClearABC"><code class="docutils literal notranslate"><span class="pre">OnRawReactionClearABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_raw_reaction_clear_emoji_abc">cpl_discord.events.on_raw_reaction_clear_emoji_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_raw_reaction_clear_emoji_abc.OnRawReactionClearEmojiABC"><code class="docutils literal notranslate"><span class="pre">OnRawReactionClearEmojiABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_raw_reaction_remove_abc">cpl_discord.events.on_raw_reaction_remove_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_raw_reaction_remove_abc.OnRawReactionRemoveABC"><code class="docutils literal notranslate"><span class="pre">OnRawReactionRemoveABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_reaction_add_abc">cpl_discord.events.on_reaction_add_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_reaction_add_abc.OnReactionAddABC"><code class="docutils literal notranslate"><span class="pre">OnReactionAddABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_reaction_clear_abc">cpl_discord.events.on_reaction_clear_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_reaction_clear_abc.OnReactionClearABC"><code class="docutils literal notranslate"><span class="pre">OnReactionClearABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_reaction_clear_emoji_abc">cpl_discord.events.on_reaction_clear_emoji_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_reaction_clear_emoji_abc.OnReactionClearEmojiABC"><code class="docutils literal notranslate"><span class="pre">OnReactionClearEmojiABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_reaction_remove_abc">cpl_discord.events.on_reaction_remove_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_reaction_remove_abc.OnReactionRemoveABC"><code class="docutils literal notranslate"><span class="pre">OnReactionRemoveABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_ready_abc">cpl_discord.events.on_ready_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_ready_abc.OnReadyABC"><code class="docutils literal notranslate"><span class="pre">OnReadyABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_resume_abc">cpl_discord.events.on_resume_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_resume_abc.OnResumeABC"><code class="docutils literal notranslate"><span class="pre">OnResumeABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_typing_abc">cpl_discord.events.on_typing_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_typing_abc.OnTypingABC"><code class="docutils literal notranslate"><span class="pre">OnTypingABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_user_update_abc">cpl_discord.events.on_user_update_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_user_update_abc.OnUserUpdateABC"><code class="docutils literal notranslate"><span class="pre">OnUserUpdateABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_voice_state_update_abc">cpl_discord.events.on_voice_state_update_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_voice_state_update_abc.OnVoiceStateUpdateABC"><code class="docutils literal notranslate"><span class="pre">OnVoiceStateUpdateABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_webhooks_update_abc">cpl_discord.events.on_webhooks_update_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.on_webhooks_update_abc.OnWebhooksUpdateABC"><code class="docutils literal notranslate"><span class="pre">OnWebhooksUpdateABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-discord-cpl-discord">cpl-discord CPL Discord</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.events.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -130,9 +289,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_discord.html">Discord Reference</a> &raquo;</li>
<li>cpl_discord.events package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_discord.html">Discord Reference</a></li>
<li class="breadcrumb-item active">cpl_discord.events package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_discord.events.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -323,7 +482,7 @@
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_channel_pins_update_abc.OnGuildChannelPinsUpdateABC.on_guild_channel_pins_update">
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_channel_pins_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_pin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_guild_channel_pins_update_abc.OnGuildChannelPinsUpdateABC.on_guild_channel_pins_update" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_channel_pins_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_pin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_guild_channel_pins_update_abc.OnGuildChannelPinsUpdateABC.on_guild_channel_pins_update" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@@ -645,7 +804,7 @@
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_discord.events.on_private_channel_pins_update_abc.OnPrivateChannelPinsUpdateABC.on_private_channel_pins_update">
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_private_channel_pins_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PrivateChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_pin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_private_channel_pins_update_abc.OnPrivateChannelPinsUpdateABC.on_private_channel_pins_update" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_private_channel_pins_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PrivateChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_pin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_private_channel_pins_update_abc.OnPrivateChannelPinsUpdateABC.on_private_channel_pins_update" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@@ -813,7 +972,7 @@
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_discord.events.on_typing_abc.OnTypingABC.on_typing">
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_typing</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Messageable</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">User</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Member</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">when</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_typing_abc.OnTypingABC.on_typing" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_typing</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Messageable</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Member</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">when</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_typing_abc.OnTypingABC.on_typing" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@@ -867,15 +1026,16 @@
<h3>cpl-discord CPL Discord<a class="headerlink" href="#cpl-discord-cpl-discord" title="Permalink to this heading"></a></h3>
<p>Link between discord.py and CPL</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2022 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_discord.events.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -900,7 +1060,6 @@
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_discord.helper package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord Reference</a><ul class="current">
@@ -52,9 +57,13 @@
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html">cpl_discord.events package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_discord.helper package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.helper.to_containers_converter">cpl_discord.helper.to_containers_converter module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.helper.to_containers_converter">cpl_discord.helper.to_containers_converter module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.helper.to_containers_converter.ToContainersConverter"><code class="docutils literal notranslate"><span class="pre">ToContainersConverter</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.helper">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-discord-cpl-discord">cpl-discord CPL Discord</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.helper.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -80,9 +89,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_discord.html">Discord Reference</a> &raquo;</li>
<li>cpl_discord.helper package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_discord.html">Discord Reference</a></li>
<li class="breadcrumb-item active">cpl_discord.helper package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_discord.helper.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -105,7 +114,7 @@
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_discord.helper.to_containers_converter.ToContainersConverter.convert">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">convert</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_l</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</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">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Sequence</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">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.container.Container" title="cpl_discord.container.container.Container"><span class="pre">cpl_discord.container.container.Container</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_discord.helper.to_containers_converter.ToContainersConverter.convert" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">convert</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_l</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</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">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.container.Container" title="cpl_discord.container.container.Container"><span class="pre">cpl_discord.container.container.Container</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_discord.helper.to_containers_converter.ToContainersConverter.convert" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@@ -117,15 +126,16 @@
<h3>cpl-discord CPL Discord<a class="headerlink" href="#cpl-discord-cpl-discord" title="Permalink to this heading"></a></h3>
<p>Link between discord.py and CPL</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2022 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_discord.helper.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.helper.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.helper.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -150,7 +160,6 @@
</dd></dl>
</section>
</section>
</section>

File diff suppressed because it is too large Load Diff

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_discord.service package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord Reference</a><ul class="current">
@@ -53,15 +58,37 @@
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.helper.html">cpl_discord.helper package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_discord.service package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.command_error_handler_service">cpl_discord.service.command_error_handler_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.discord_bot_service">cpl_discord.service.discord_bot_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.discord_bot_service_abc">cpl_discord.service.discord_bot_service_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.discord_collection">cpl_discord.service.discord_collection module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.discord_collection_abc">cpl_discord.service.discord_collection_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.discord_service">cpl_discord.service.discord_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.discord_service_abc">cpl_discord.service.discord_service_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.command_error_handler_service">cpl_discord.service.command_error_handler_service module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.service.command_error_handler_service.CommandErrorHandlerService"><code class="docutils literal notranslate"><span class="pre">CommandErrorHandlerService</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.discord_bot_service">cpl_discord.service.discord_bot_service module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.service.discord_bot_service.DiscordBotService"><code class="docutils literal notranslate"><span class="pre">DiscordBotService</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.discord_bot_service_abc">cpl_discord.service.discord_bot_service_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC"><code class="docutils literal notranslate"><span class="pre">DiscordBotServiceABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.discord_collection">cpl_discord.service.discord_collection module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.service.discord_collection.DiscordCollection"><code class="docutils literal notranslate"><span class="pre">DiscordCollection</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.discord_collection_abc">cpl_discord.service.discord_collection_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.service.discord_collection_abc.DiscordCollectionABC"><code class="docutils literal notranslate"><span class="pre">DiscordCollectionABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.discord_service">cpl_discord.service.discord_service module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.service.discord_service.DiscordService"><code class="docutils literal notranslate"><span class="pre">DiscordService</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.discord_service_abc">cpl_discord.service.discord_service_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC"><code class="docutils literal notranslate"><span class="pre">DiscordServiceABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-discord-cpl-discord">cpl-discord CPL Discord</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_discord.service.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -86,9 +113,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_discord.html">Discord Reference</a> &raquo;</li>
<li>cpl_discord.service package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_discord.html">Discord Reference</a></li>
<li class="breadcrumb-item active">cpl_discord.service package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_discord.service.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -121,7 +148,7 @@
<span id="cpl-discord-service-discord-bot-service-module"></span><h2>cpl_discord.service.discord_bot_service module<a class="headerlink" href="#module-cpl_discord.service.discord_bot_service" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_discord.service.discord_bot_service.DiscordBotService">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.service.discord_bot_service.</span></span><span class="sig-name descname"><span class="pre">DiscordBotService</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_abc.LoggerABC" title="cpl_core.logging.logger_abc.LoggerABC"><span class="pre">LoggerABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">discord_bot_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_discord.configuration.html#cpl_discord.configuration.discord_bot_settings.DiscordBotSettings" title="cpl_discord.configuration.discord_bot_settings.DiscordBotSettings"><span class="pre">DiscordBotSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">logging_st</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_settings.LoggingSettings" title="cpl_core.logging.logging_settings.LoggingSettings"><span class="pre">LoggingSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">discord_service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC" title="cpl_discord.service.discord_service_abc.DiscordServiceABC"><span class="pre">DiscordServiceABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_bot_service.DiscordBotService" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.service.discord_bot_service.</span></span><span class="sig-name descname"><span class="pre">DiscordBotService</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_abc.LoggerABC" title="cpl_core.logging.logger_abc.LoggerABC"><span class="pre">LoggerABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">discord_bot_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_discord.configuration.html#cpl_discord.configuration.discord_bot_settings.DiscordBotSettings" title="cpl_discord.configuration.discord_bot_settings.DiscordBotSettings"><span class="pre">DiscordBotSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">logging_st</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_settings.LoggingSettings" title="cpl_core.logging.logging_settings.LoggingSettings"><span class="pre">LoggingSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">discord_service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC" title="cpl_discord.service.discord_service_abc.DiscordServiceABC"><span class="pre">DiscordServiceABC</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_bot_service.DiscordBotService" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC" title="cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">DiscordBotServiceABC</span></code></a></p>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_discord.service.discord_bot_service.DiscordBotService.guilds">
@@ -151,7 +178,7 @@
<span id="cpl-discord-service-discord-bot-service-abc-module"></span><h2>cpl_discord.service.discord_bot_service_abc module<a class="headerlink" href="#module-cpl_discord.service.discord_bot_service_abc" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.service.discord_bot_service_abc.</span></span><span class="sig-name descname"><span class="pre">DiscordBotServiceABC</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">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.service.discord_bot_service_abc.</span></span><span class="sig-name descname"><span class="pre">DiscordBotServiceABC</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>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Bot</span></code></p>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC.guilds">
@@ -200,7 +227,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_discord.service.discord_collection.DiscordCollection.get_events_by_base">
<span class="sig-name descname"><span class="pre">get_events_by_base</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t_event</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.list.List" title="cpl_query.extension.list.List"><span class="pre">List</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_discord.service.discord_collection.DiscordCollection.get_events_by_base" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">get_events_by_base</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t_event</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.list.List" title="cpl_query.extension.list.List"><span class="pre">List</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_discord.service.discord_collection.DiscordCollection.get_events_by_base" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@@ -308,7 +335,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_guild_channel_pins_update">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_channel_pins_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_pin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_guild_channel_pins_update" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_channel_pins_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_pin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_guild_channel_pins_update" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
@@ -423,7 +450,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_private_channel_pins_update">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_private_channel_pins_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PrivateChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_pin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_private_channel_pins_update" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_private_channel_pins_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PrivateChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_pin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_private_channel_pins_update" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
@@ -481,9 +508,34 @@
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_resume</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_resume" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_scheduled_event_create">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_scheduled_event_create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ScheduledEvent</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_scheduled_event_create" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_scheduled_event_delete">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_scheduled_event_delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ScheduledEvent</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_scheduled_event_delete" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_scheduled_event_update">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_scheduled_event_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ScheduledEvent</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ScheduledEvent</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_scheduled_event_update" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_scheduled_event_user_add">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_scheduled_event_user_add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ScheduledEvent</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_scheduled_event_user_add" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_scheduled_event_user_remove">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_scheduled_event_user_remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ScheduledEvent</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_scheduled_event_user_remove" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_typing">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_typing</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Messageable</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">User</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Member</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">when</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_typing" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_typing</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Messageable</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Member</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">when</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_typing" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
@@ -577,7 +629,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_channel_pins_update">
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_channel_pins_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_pin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_channel_pins_update" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_channel_pins_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_pin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_channel_pins_update" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
@@ -692,7 +744,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_private_channel_pins_update">
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_private_channel_pins_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PrivateChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_pin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_private_channel_pins_update" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_private_channel_pins_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PrivateChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_pin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_private_channel_pins_update" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
@@ -732,7 +784,7 @@
<dl class="py method">
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_typing">
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_typing</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Messageable</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">User</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Member</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">when</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_typing" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_typing</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Messageable</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Member</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">when</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_typing" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
@@ -759,15 +811,16 @@
<h3>cpl-discord CPL Discord<a class="headerlink" href="#cpl-discord-cpl-discord" title="Permalink to this heading"></a></h3>
<p>Link between discord.py and CPL</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2022 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_discord.service.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.service.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -792,7 +845,6 @@
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_query.base package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,19 +46,36 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="cpl_query.html">Query reference</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_query.base package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.default_lambda">cpl_query.base.default_lambda module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.ordered_queryable">cpl_query.base.ordered_queryable module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.ordered_queryable_abc">cpl_query.base.ordered_queryable_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.queryable_abc">cpl_query.base.queryable_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.sequence">cpl_query.base.sequence module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.default_lambda">cpl_query.base.default_lambda module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.base.default_lambda.default_lambda"><code class="docutils literal notranslate"><span class="pre">default_lambda()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.ordered_queryable">cpl_query.base.ordered_queryable module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.base.ordered_queryable.OrderedQueryable"><code class="docutils literal notranslate"><span class="pre">OrderedQueryable</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.ordered_queryable_abc">cpl_query.base.ordered_queryable_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="docutils literal notranslate"><span class="pre">OrderedQueryableABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.queryable_abc">cpl_query.base.queryable_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC"><code class="docutils literal notranslate"><span class="pre">QueryableABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.sequence">cpl_query.base.sequence module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.base.sequence.Sequence"><code class="docutils literal notranslate"><span class="pre">Sequence</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.base.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -80,9 +101,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_query.html">Query reference</a> &raquo;</li>
<li>cpl_query.base package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_query.html">Query reference</a></li>
<li class="breadcrumb-item active">cpl_query.base package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_query.base.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -109,9 +130,9 @@
<span id="cpl-query-base-ordered-queryable-module"></span><h2>cpl_query.base.ordered_queryable module<a class="headerlink" href="#module-cpl_query.base.ordered_queryable" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable.OrderedQueryable">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.ordered_queryable.</span></span><span class="sig-name descname"><span class="pre">OrderedQueryable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable.Iterable" title="cpl_query.iterable.iterable.Iterable"><span class="pre">Iterable</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.ordered_queryable.OrderedQueryable" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.ordered_queryable.</span></span><span class="sig-name descname"><span class="pre">OrderedQueryable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable.Iterable" title="cpl_query.iterable.iterable.Iterable"><span class="pre">Iterable</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.ordered_queryable.OrderedQueryable" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">OrderedQueryableABC</span></code></a></p>
<p>Implementation of :class: <cite>cpl_query.extension.Iterable</cite> <cite>cpl_query.extension.OrderedIterableABC</cite></p>
<p>Implementation of :class: <cite>cpl_query.base.ordered_queryable_abc.OrderedQueryableABC</cite></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable.OrderedQueryable.then_by">
<span class="sig-name descname"><span class="pre">then_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.ordered_queryable.OrderedQueryable.then_by" title="Permalink to this definition"></a></dt>
@@ -143,7 +164,7 @@
<span id="cpl-query-base-ordered-queryable-abc-module"></span><h2>cpl_query.base.ordered_queryable_abc module<a class="headerlink" href="#module-cpl_query.base.ordered_queryable_abc" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.ordered_queryable_abc.</span></span><span class="sig-name descname"><span class="pre">OrderedQueryableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.ordered_queryable_abc.</span></span><span class="sig-name descname"><span class="pre">OrderedQueryableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryableABC</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC.then_by">
@@ -176,465 +197,607 @@
<span id="cpl-query-base-queryable-abc-module"></span><h2>cpl_query.base.queryable_abc module<a class="headerlink" href="#module-cpl_query.base.queryable_abc" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.queryable_abc.</span></span><span class="sig-name descname"><span class="pre">QueryableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.queryable_abc.</span></span><span class="sig-name descname"><span class="pre">QueryableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl_query.base.sequence.Sequence" title="cpl_query.base.sequence.Sequence"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.all">
<span class="sig-name descname"><span class="pre">all</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.all" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">all</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.all" title="Permalink to this definition"></a></dt>
<dd><p>Checks if every element of list equals result found by function</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="parameter">
<h3>Parameter<a class="headerlink" href="#parameter" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><p>bool</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="returns">
<h3>Returns<a class="headerlink" href="#returns" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>bool</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.any">
<span class="sig-name descname"><span class="pre">any</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.any" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">any</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.any" title="Permalink to this definition"></a></dt>
<dd><p>Checks if list contains result found by function</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id1">
<h3>Parameter<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><p>bool</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="id2">
<h3>Returns<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>bool</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.average">
<span class="sig-name descname"><span class="pre">average</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.average" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">average</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">complex</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.average" title="Permalink to this definition"></a></dt>
<dd><p>Returns average value of list</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id3">
<h3>Parameter<a class="headerlink" href="#id3" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><p>Union[int, float, complex]</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="id4">
<h3>Returns<a class="headerlink" href="#id4" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Union[int, float, complex]</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.contains">
<span class="sig-name descname"><span class="pre">contains</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.contains" title="Permalink to this definition"></a></dt>
<dd><p>Checks if list contains value given by function</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id5">
<h3>Parameter<a class="headerlink" href="#id5" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>value: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></dt><dd><p>value</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><p>bool</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="id6">
<h3>Returns<a class="headerlink" href="#id6" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>bool</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.count">
<span class="sig-name descname"><span class="pre">count</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.count" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">count</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.count" title="Permalink to this definition"></a></dt>
<dd><p>Returns length of list or count of found elements</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id7">
<h3>Parameter<a class="headerlink" href="#id7" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><p>int</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="id8">
<h3>Returns<a class="headerlink" href="#id8" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>int</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.distinct">
<span class="sig-name descname"><span class="pre">distinct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.distinct" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">distinct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.distinct" title="Permalink to this definition"></a></dt>
<dd><p>Returns list without redundancies</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id9">
<h3>Parameter<a class="headerlink" href="#id9" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><dl class="field-list simple">
<dt class="field-odd">class</dt>
</div></blockquote>
</section>
<section id="id10">
<h3>Returns<a class="headerlink" href="#id10" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
</dd>
</dl>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.element_at">
<span class="sig-name descname"><span class="pre">element_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.element_at" title="Permalink to this definition"></a></dt>
<dd><p>Returns element at given index</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id11">
<h3>Parameter<a class="headerlink" href="#id11" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>_index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><p>Value at _index: any</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="id12">
<h3>Returns<a class="headerlink" href="#id12" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Value at _index: any</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.element_at_or_default">
<span class="sig-name descname"><span class="pre">element_at_or_default</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.element_at_or_default" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">element_at_or_default</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.element_at_or_default" title="Permalink to this definition"></a></dt>
<dd><p>Returns element at given index or None</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id13">
<h3>Parameter<a class="headerlink" href="#id13" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>_index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><p>Value at _index: Optional[any]</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="id14">
<h3>Returns<a class="headerlink" href="#id14" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Value at _index: Optional[any]</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.first">
<span class="sig-name descname"><span class="pre">first</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.first" title="Permalink to this definition"></a></dt>
<dd><p>Returns first element</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>First element of list: any</p>
</dd>
</dl>
<section id="id15">
<h3>Returns<a class="headerlink" href="#id15" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>First element of list: any</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.first_or_default">
<span class="sig-name descname"><span class="pre">first_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.first_or_default" title="Permalink to this definition"></a></dt>
<dd><p>Returns first element or None</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>First element of list: Optional[any]</p>
</dd>
</dl>
<section id="id16">
<h3>Returns<a class="headerlink" href="#id16" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>First element of list: Optional[any]</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.for_each">
<span class="sig-name descname"><span class="pre">for_each</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.for_each" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">for_each</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.for_each" title="Permalink to this definition"></a></dt>
<dd><p>Runs given function for each element of list</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id17">
<h3>Parameter<a class="headerlink" href="#id17" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>func: :class: <cite>Callable</cite></dt><dd><p>function to call</p>
</dd>
</dl>
</dd>
</dl>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.group_by">
<span class="sig-name descname"><span class="pre">group_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.group_by" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">group_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.group_by" title="Permalink to this definition"></a></dt>
<dd><p>Groups by func</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>Grouped list[list[any]]: any</p>
</dd>
</dl>
<section id="id18">
<h3>Returns<a class="headerlink" href="#id18" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Grouped list[list[any]]: any</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.last">
<span class="sig-name descname"><span class="pre">last</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.last" title="Permalink to this definition"></a></dt>
<dd><p>Returns last element</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>Last element of list: any</p>
</dd>
</dl>
<section id="id19">
<h3>Returns<a class="headerlink" href="#id19" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Last element of list: any</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.last_or_default">
<span class="sig-name descname"><span class="pre">last_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.last_or_default" title="Permalink to this definition"></a></dt>
<dd><p>Returns last element or None</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>Last element of list: Optional[any]</p>
</dd>
</dl>
<section id="id20">
<h3>Returns<a class="headerlink" href="#id20" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Last element of list: Optional[any]</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.max">
<span class="sig-name descname"><span class="pre">max</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.max" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">max</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.max" title="Permalink to this definition"></a></dt>
<dd><p>Returns the highest value</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id21">
<h3>Parameter<a class="headerlink" href="#id21" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><p>object</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="id22">
<h3>Returns<a class="headerlink" href="#id22" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>object</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.median">
<span class="sig-name descname"><span class="pre">median</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.median" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">median</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.median" title="Permalink to this definition"></a></dt>
<dd><p>Return the median value of data elements</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>Union[int, float]</p>
</dd>
</dl>
<section id="id23">
<h3>Returns<a class="headerlink" href="#id23" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Union[int, float]</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.min">
<span class="sig-name descname"><span class="pre">min</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.min" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">min</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.min" title="Permalink to this definition"></a></dt>
<dd><p>Returns the lowest value</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id24">
<h3>Parameter<a class="headerlink" href="#id24" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><p>object</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="id25">
<h3>Returns<a class="headerlink" href="#id25" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>object</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.order_by">
<span class="sig-name descname"><span class="pre">order_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.order_by" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">order_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.order_by" title="Permalink to this definition"></a></dt>
<dd><p>Sorts elements by function in ascending order</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id26">
<h3>Parameter<a class="headerlink" href="#id26" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="id27">
<h3>Returns<a class="headerlink" href="#id27" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>cpl_query.base.ordered_queryable_abc.OrderedQueryableABC</cite></p>
</dd>
</dl>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.order_by_descending">
<span class="sig-name descname"><span class="pre">order_by_descending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.order_by_descending" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">order_by_descending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.order_by_descending" title="Permalink to this definition"></a></dt>
<dd><p>Sorts elements by function in descending order</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id28">
<h3>Parameter<a class="headerlink" href="#id28" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="id29">
<h3>Returns<a class="headerlink" href="#id29" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>cpl_query.base.ordered_queryable_abc.OrderedQueryableABC</cite></p>
</dd>
</dl>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.reverse">
<span class="sig-name descname"><span class="pre">reverse</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.reverse" title="Permalink to this definition"></a></dt>
<dd><p>Reverses list</p>
<dl class="simple">
<dt>Returns:</dt><dd><dl class="field-list simple">
<dt class="field-odd">class</dt>
<section id="id30">
<h3>Returns<a class="headerlink" href="#id30" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
</dd>
</dl>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.select">
<span class="sig-name descname"><span class="pre">select</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.select" title="Permalink to this definition"></a></dt>
<dd><p>Formats each element of list to a given format</p>
<dl class="simple">
<dt>Returns:</dt><dd><dl class="field-list simple">
<dt class="field-odd">class</dt>
<section id="id31">
<h3>Returns<a class="headerlink" href="#id31" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
</dd>
</dl>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.select_many">
<span class="sig-name descname"><span class="pre">select_many</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.select_many" title="Permalink to this definition"></a></dt>
<dd><p>Flattens resulting lists to one</p>
<dl class="simple">
<dt>Returns:</dt><dd><dl class="field-list simple">
<dt class="field-odd">class</dt>
<section id="id32">
<h3>Returns<a class="headerlink" href="#id32" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
</dd>
</dl>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.single">
<span class="sig-name descname"><span class="pre">single</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.single" title="Permalink to this definition"></a></dt>
<dd><p>Returns one single element of list</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>Found value: any</p>
</dd>
<dt>Raises:</dt><dd><p>ArgumentNoneException: when argument is None
<section id="id33">
<h3>Returns<a class="headerlink" href="#id33" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Found value: any</p>
</div></blockquote>
</section>
<section id="raises">
<h3>Raises<a class="headerlink" href="#raises" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>ArgumentNoneException: when argument is None
Exception: when argument is None or found more than one element</p>
</dd>
</dl>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.single_or_default">
<span class="sig-name descname"><span class="pre">single_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.single_or_default" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">single_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.single_or_default" title="Permalink to this definition"></a></dt>
<dd><p>Returns one single element of list</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>Found value: Optional[any]</p>
</dd>
</dl>
<section id="id34">
<h3>Returns<a class="headerlink" href="#id34" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Found value: Optional[any]</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.skip">
<span class="sig-name descname"><span class="pre">skip</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.skip" title="Permalink to this definition"></a></dt>
<dd><p>Skips all elements from index</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id35">
<h3>Parameter<a class="headerlink" href="#id35" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>_index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><dl class="field-list simple">
<dt class="field-odd">class</dt>
</div></blockquote>
</section>
<section id="id36">
<h3>Returns<a class="headerlink" href="#id36" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
</dd>
</dl>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.skip_last">
<span class="sig-name descname"><span class="pre">skip_last</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.skip_last" title="Permalink to this definition"></a></dt>
<dd><p>Skips all elements after index</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id37">
<h3>Parameter<a class="headerlink" href="#id37" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>_index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><dl class="field-list simple">
<dt class="field-odd">class</dt>
</div></blockquote>
</section>
<section id="id38">
<h3>Returns<a class="headerlink" href="#id38" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
</dd>
</dl>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.split">
<span class="sig-name descname"><span class="pre">split</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.split" title="Permalink to this definition"></a></dt>
<dd><p>Splits the list by given function</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id39">
<h3>Parameter<a class="headerlink" href="#id39" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>seperator</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><dl class="field-list simple">
<dt class="field-odd">class</dt>
</div></blockquote>
</section>
<section id="id40">
<h3>Returns<a class="headerlink" href="#id40" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
</dd>
</dl>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.sum">
<span class="sig-name descname"><span class="pre">sum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.sum" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">sum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">complex</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.sum" title="Permalink to this definition"></a></dt>
<dd><p>Sum of all values</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id41">
<h3>Parameter<a class="headerlink" href="#id41" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><p>Union[int, float, complex]</p>
</dd>
</dl>
</div></blockquote>
</section>
<section id="id42">
<h3>Returns<a class="headerlink" href="#id42" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Union[int, float, complex]</p>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.take">
<span class="sig-name descname"><span class="pre">take</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.take" title="Permalink to this definition"></a></dt>
<dd><p>Takes all elements from index</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id43">
<h3>Parameter<a class="headerlink" href="#id43" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>_index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><dl class="field-list simple">
<dt class="field-odd">class</dt>
</div></blockquote>
</section>
<section id="id44">
<h3>Returns<a class="headerlink" href="#id44" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
</dd>
</dl>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.take_last">
<span class="sig-name descname"><span class="pre">take_last</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.take_last" title="Permalink to this definition"></a></dt>
<dd><p>Takes all elements after index</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id45">
<h3>Parameter<a class="headerlink" href="#id45" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>_index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><dl class="field-list simple">
<dt class="field-odd">class</dt>
</div></blockquote>
</section>
<section id="id46">
<h3>Returns<a class="headerlink" href="#id46" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
</dd>
</dl>
</div></blockquote>
</section>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.where">
<span class="sig-name descname"><span class="pre">where</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.where" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">where</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.where" title="Permalink to this definition"></a></dt>
<dd><p>Select element by function</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
<section id="id47">
<h3>Parameter<a class="headerlink" href="#id47" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><dl class="field-list simple">
<dt class="field-odd">class</dt>
</div></blockquote>
</section>
<section id="id48">
<h3>Returns<a class="headerlink" href="#id48" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
</dd>
</dl>
</div></blockquote>
</section>
</dd></dl>
</dd></dl>
@@ -644,7 +807,7 @@ Exception: when argument is None or found more than one element</p>
<span id="cpl-query-base-sequence-module"></span><h2>cpl_query.base.sequence module<a class="headerlink" href="#module-cpl_query.base.sequence" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.base.sequence.Sequence">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.sequence.</span></span><span class="sig-name descname"><span class="pre">Sequence</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.sequence.Sequence" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.sequence.</span></span><span class="sig-name descname"><span class="pre">Sequence</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.sequence.Sequence" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.sequence.Sequence.copy">
@@ -689,7 +852,7 @@ Exception: when argument is None or found more than one element</p>
<dd><p>Converts :class: <cite>cpl_query.base.sequence_abc.SequenceABC</cite> to :class: <cite>list</cite></p>
<dl class="simple">
<dt>Returns:</dt><dd><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>list</cite></p>
</dd>
</dl>
@@ -711,15 +874,16 @@ Exception: when argument is None or found more than one element</p>
<h3>cpl-query CPL Queries<a class="headerlink" href="#cpl-query-cpl-queries" title="Permalink to this heading"></a></h3>
<p>CPL Python integrated Queries</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2021 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.base.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -744,7 +908,6 @@ Exception: when argument is None or found more than one element</p>
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_query.enumerable package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -49,10 +54,17 @@
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html">cpl_query.base package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_query.enumerable package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.enumerable.enumerable">cpl_query.enumerable.enumerable module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.enumerable.enumerable_abc">cpl_query.enumerable.enumerable_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.enumerable.enumerable">cpl_query.enumerable.enumerable module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.enumerable.enumerable.Enumerable"><code class="docutils literal notranslate"><span class="pre">Enumerable</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.enumerable.enumerable_abc">cpl_query.enumerable.enumerable_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.enumerable.enumerable_abc.EnumerableABC"><code class="docutils literal notranslate"><span class="pre">EnumerableABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.enumerable">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.enumerable.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -77,9 +89,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_query.html">Query reference</a> &raquo;</li>
<li>cpl_query.enumerable package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_query.html">Query reference</a></li>
<li class="breadcrumb-item active">cpl_query.enumerable package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_query.enumerable.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -98,7 +110,7 @@
<span id="cpl-query-enumerable-enumerable-module"></span><h2>cpl_query.enumerable.enumerable module<a class="headerlink" href="#module-cpl_query.enumerable.enumerable" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.enumerable.enumerable.Enumerable">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.enumerable.enumerable.</span></span><span class="sig-name descname"><span class="pre">Enumerable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">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="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">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="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.enumerable.enumerable.Enumerable" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.enumerable.enumerable.</span></span><span class="sig-name descname"><span class="pre">Enumerable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.enumerable.enumerable.Enumerable" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl_query.enumerable.enumerable_abc.EnumerableABC" title="cpl_query.enumerable.enumerable_abc.EnumerableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EnumerableABC</span></code></a></p>
<p>Implementation of :class: <cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite></p>
</dd></dl>
@@ -108,7 +120,7 @@
<span id="cpl-query-enumerable-enumerable-abc-module"></span><h2>cpl_query.enumerable.enumerable_abc module<a class="headerlink" href="#module-cpl_query.enumerable.enumerable_abc" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.enumerable.enumerable_abc.EnumerableABC">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.enumerable.enumerable_abc.</span></span><span class="sig-name descname"><span class="pre">EnumerableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">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="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">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="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.enumerable.enumerable_abc.EnumerableABC" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.enumerable.enumerable_abc.</span></span><span class="sig-name descname"><span class="pre">EnumerableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.enumerable.enumerable_abc.EnumerableABC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryableABC</span></code></a></p>
<p>ABC to define functions on list</p>
<dl class="py method">
@@ -117,7 +129,7 @@
<dd><p>Converts :class: <cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite> to :class: <cite>cpl_query.iterable.iterable_abc.IterableABC</cite></p>
<dl class="simple">
<dt>Returns:</dt><dd><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>cpl_query.iterable.iterable_abc.IterableABC</cite></p>
</dd>
</dl>
@@ -134,15 +146,16 @@
<h3>cpl-query CPL Queries<a class="headerlink" href="#cpl-query-cpl-queries" title="Permalink to this heading"></a></h3>
<p>CPL Python integrated Queries</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2021 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.enumerable.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.enumerable.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.enumerable.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -167,7 +180,6 @@
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_query.extension package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -50,9 +55,13 @@
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html">cpl_query.enumerable package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_query.extension package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.extension.list">cpl_query.extension.list module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.extension.list">cpl_query.extension.list module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.extension.list.List"><code class="docutils literal notranslate"><span class="pre">List</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.extension">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.extension.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -76,9 +85,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_query.html">Query reference</a> &raquo;</li>
<li>cpl_query.extension package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_query.html">Query reference</a></li>
<li class="breadcrumb-item active">cpl_query.extension package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_query.extension.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -97,7 +106,7 @@
<span id="cpl-query-extension-list-module"></span><h2>cpl_query.extension.list module<a class="headerlink" href="#module-cpl_query.extension.list" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.extension.list.List">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.extension.list.</span></span><span class="sig-name descname"><span class="pre">List</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">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="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterator</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.list.List" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.extension.list.</span></span><span class="sig-name descname"><span class="pre">List</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterator</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.list.List" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable.Iterable" title="cpl_query.iterable.iterable.Iterable"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code></a></p>
<p>Implementation of :class: <cite>cpl_query.extension.iterable.Iterable</cite></p>
<dl class="py method">
@@ -106,7 +115,7 @@
<dd><p>Converts :class: <cite>cpl_query.iterable.iterable_abc.IterableABC</cite> to :class: <cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite></p>
<dl class="simple">
<dt>Returns:</dt><dd><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite></p>
</dd>
</dl>
@@ -120,7 +129,7 @@
<dd><p>Converts :class: <cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite> to :class: <cite>cpl_query.iterable.iterable_abc.IterableABC</cite></p>
<dl class="simple">
<dt>Returns:</dt><dd><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>cpl_query.iterable.iterable_abc.IterableABC</cite></p>
</dd>
</dl>
@@ -137,15 +146,16 @@
<h3>cpl-query CPL Queries<a class="headerlink" href="#cpl-query-cpl-queries" title="Permalink to this heading"></a></h3>
<p>CPL Python integrated Queries</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2021 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.extension.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.extension.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -170,7 +180,6 @@
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Query reference &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -68,8 +73,8 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Query reference</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Query reference</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_query.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -85,42 +90,160 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="cpl_query.base.html">cpl_query.base package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.default_lambda">cpl_query.base.default_lambda module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.ordered_queryable">cpl_query.base.ordered_queryable module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.ordered_queryable_abc">cpl_query.base.ordered_queryable_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.queryable_abc">cpl_query.base.queryable_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.sequence">cpl_query.base.sequence module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.default_lambda">cpl_query.base.default_lambda module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.default_lambda.default_lambda"><code class="docutils literal notranslate"><span class="pre">default_lambda()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.ordered_queryable">cpl_query.base.ordered_queryable module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.ordered_queryable.OrderedQueryable"><code class="docutils literal notranslate"><span class="pre">OrderedQueryable</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.ordered_queryable.OrderedQueryable.then_by"><code class="docutils literal notranslate"><span class="pre">OrderedQueryable.then_by()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.ordered_queryable.OrderedQueryable.then_by_descending"><code class="docutils literal notranslate"><span class="pre">OrderedQueryable.then_by_descending()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.ordered_queryable_abc">cpl_query.base.ordered_queryable_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="docutils literal notranslate"><span class="pre">OrderedQueryableABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC.then_by"><code class="docutils literal notranslate"><span class="pre">OrderedQueryableABC.then_by()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC.then_by_descending"><code class="docutils literal notranslate"><span class="pre">OrderedQueryableABC.then_by_descending()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.queryable_abc">cpl_query.base.queryable_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC"><code class="docutils literal notranslate"><span class="pre">QueryableABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.all"><code class="docutils literal notranslate"><span class="pre">QueryableABC.all()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.any"><code class="docutils literal notranslate"><span class="pre">QueryableABC.any()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.average"><code class="docutils literal notranslate"><span class="pre">QueryableABC.average()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.contains"><code class="docutils literal notranslate"><span class="pre">QueryableABC.contains()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.count"><code class="docutils literal notranslate"><span class="pre">QueryableABC.count()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.distinct"><code class="docutils literal notranslate"><span class="pre">QueryableABC.distinct()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.element_at"><code class="docutils literal notranslate"><span class="pre">QueryableABC.element_at()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.element_at_or_default"><code class="docutils literal notranslate"><span class="pre">QueryableABC.element_at_or_default()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.first"><code class="docutils literal notranslate"><span class="pre">QueryableABC.first()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.first_or_default"><code class="docutils literal notranslate"><span class="pre">QueryableABC.first_or_default()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.for_each"><code class="docutils literal notranslate"><span class="pre">QueryableABC.for_each()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.group_by"><code class="docutils literal notranslate"><span class="pre">QueryableABC.group_by()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.last"><code class="docutils literal notranslate"><span class="pre">QueryableABC.last()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.last_or_default"><code class="docutils literal notranslate"><span class="pre">QueryableABC.last_or_default()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.max"><code class="docutils literal notranslate"><span class="pre">QueryableABC.max()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.median"><code class="docutils literal notranslate"><span class="pre">QueryableABC.median()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.min"><code class="docutils literal notranslate"><span class="pre">QueryableABC.min()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.order_by"><code class="docutils literal notranslate"><span class="pre">QueryableABC.order_by()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.order_by_descending"><code class="docutils literal notranslate"><span class="pre">QueryableABC.order_by_descending()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.reverse"><code class="docutils literal notranslate"><span class="pre">QueryableABC.reverse()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.select"><code class="docutils literal notranslate"><span class="pre">QueryableABC.select()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.select_many"><code class="docutils literal notranslate"><span class="pre">QueryableABC.select_many()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.single"><code class="docutils literal notranslate"><span class="pre">QueryableABC.single()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.single_or_default"><code class="docutils literal notranslate"><span class="pre">QueryableABC.single_or_default()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.skip"><code class="docutils literal notranslate"><span class="pre">QueryableABC.skip()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.skip_last"><code class="docutils literal notranslate"><span class="pre">QueryableABC.skip_last()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.split"><code class="docutils literal notranslate"><span class="pre">QueryableABC.split()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.sum"><code class="docutils literal notranslate"><span class="pre">QueryableABC.sum()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.take"><code class="docutils literal notranslate"><span class="pre">QueryableABC.take()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.take_last"><code class="docutils literal notranslate"><span class="pre">QueryableABC.take_last()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.where"><code class="docutils literal notranslate"><span class="pre">QueryableABC.where()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base.sequence">cpl_query.base.sequence module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.sequence.Sequence"><code class="docutils literal notranslate"><span class="pre">Sequence</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.sequence.Sequence.copy"><code class="docutils literal notranslate"><span class="pre">Sequence.copy()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.sequence.Sequence.empty"><code class="docutils literal notranslate"><span class="pre">Sequence.empty()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.sequence.Sequence.index_of"><code class="docutils literal notranslate"><span class="pre">Sequence.index_of()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.sequence.Sequence.range"><code class="docutils literal notranslate"><span class="pre">Sequence.range()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.sequence.Sequence.to_list"><code class="docutils literal notranslate"><span class="pre">Sequence.to_list()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.sequence.Sequence.type"><code class="docutils literal notranslate"><span class="pre">Sequence.type</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html#module-cpl_query.base">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.base.html#cpl_query.base.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_query.enumerable.html">cpl_query.enumerable package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html#module-cpl_query.enumerable.enumerable">cpl_query.enumerable.enumerable module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html#module-cpl_query.enumerable.enumerable_abc">cpl_query.enumerable.enumerable_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html#module-cpl_query.enumerable.enumerable">cpl_query.enumerable.enumerable module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.enumerable.Enumerable"><code class="docutils literal notranslate"><span class="pre">Enumerable</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html#module-cpl_query.enumerable.enumerable_abc">cpl_query.enumerable.enumerable_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.enumerable_abc.EnumerableABC"><code class="docutils literal notranslate"><span class="pre">EnumerableABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.enumerable_abc.EnumerableABC.to_iterable"><code class="docutils literal notranslate"><span class="pre">EnumerableABC.to_iterable()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html#module-cpl_query.enumerable">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_query.enumerable.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_query.extension.html">cpl_query.extension package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.extension.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.extension.html#module-cpl_query.extension.list">cpl_query.extension.list module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.extension.html#module-cpl_query.extension.list">cpl_query.extension.list module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.list.List"><code class="docutils literal notranslate"><span class="pre">List</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.list.List.to_enumerable"><code class="docutils literal notranslate"><span class="pre">List.to_enumerable()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.list.List.to_iterable"><code class="docutils literal notranslate"><span class="pre">List.to_iterable()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.extension.html#module-cpl_query.extension">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_query.extension.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_query.iterable.html">cpl_query.iterable package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.iterable.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.iterable.html#module-cpl_query.iterable.iterable">cpl_query.iterable.iterable module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.iterable.html#module-cpl_query.iterable.iterable_abc">cpl_query.iterable.iterable_abc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.iterable.html#module-cpl_query.iterable.iterable">cpl_query.iterable.iterable module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable.Iterable"><code class="docutils literal notranslate"><span class="pre">Iterable</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.iterable.html#module-cpl_query.iterable.iterable_abc">cpl_query.iterable.iterable_abc module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable_abc.IterableABC"><code class="docutils literal notranslate"><span class="pre">IterableABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable_abc.IterableABC.add"><code class="docutils literal notranslate"><span class="pre">IterableABC.add()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable_abc.IterableABC.append"><code class="docutils literal notranslate"><span class="pre">IterableABC.append()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable_abc.IterableABC.extend"><code class="docutils literal notranslate"><span class="pre">IterableABC.extend()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable_abc.IterableABC.remove"><code class="docutils literal notranslate"><span class="pre">IterableABC.remove()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable_abc.IterableABC.remove_at"><code class="docutils literal notranslate"><span class="pre">IterableABC.remove_at()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable_abc.IterableABC.to_enumerable"><code class="docutils literal notranslate"><span class="pre">IterableABC.to_enumerable()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.iterable.html#module-cpl_query.iterable">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_query.iterable.html#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.VersionInfo.major"><code class="docutils literal notranslate"><span class="pre">VersionInfo.major</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.VersionInfo.micro"><code class="docutils literal notranslate"><span class="pre">VersionInfo.micro</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.VersionInfo.minor"><code class="docutils literal notranslate"><span class="pre">VersionInfo.minor</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_query.iterable package &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -51,10 +56,17 @@
<li class="toctree-l2"><a class="reference internal" href="cpl_query.extension.html">cpl_query.extension package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_query.iterable package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.iterable.iterable">cpl_query.iterable.iterable module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.iterable.iterable_abc">cpl_query.iterable.iterable_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.iterable.iterable">cpl_query.iterable.iterable module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.iterable.iterable.Iterable"><code class="docutils literal notranslate"><span class="pre">Iterable</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.iterable.iterable_abc">cpl_query.iterable.iterable_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.iterable.iterable_abc.IterableABC"><code class="docutils literal notranslate"><span class="pre">IterableABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.iterable">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.iterable.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -77,9 +89,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="cpl_query.html">Query reference</a> &raquo;</li>
<li>cpl_query.iterable package</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_query.html">Query reference</a></li>
<li class="breadcrumb-item active">cpl_query.iterable package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_query.iterable.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -98,7 +110,7 @@
<span id="cpl-query-iterable-iterable-module"></span><h2>cpl_query.iterable.iterable module<a class="headerlink" href="#module-cpl_query.iterable.iterable" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.iterable.iterable.Iterable">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.iterable.iterable.</span></span><span class="sig-name descname"><span class="pre">Iterable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">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="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.iterable.iterable.Iterable" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.iterable.iterable.</span></span><span class="sig-name descname"><span class="pre">Iterable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.iterable.iterable.Iterable" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl_query.iterable.iterable_abc.IterableABC" title="cpl_query.iterable.iterable_abc.IterableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">IterableABC</span></code></a></p>
</dd></dl>
@@ -107,7 +119,7 @@
<span id="cpl-query-iterable-iterable-abc-module"></span><h2>cpl_query.iterable.iterable_abc module<a class="headerlink" href="#module-cpl_query.iterable.iterable_abc" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.iterable.iterable_abc.IterableABC">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.iterable.iterable_abc.</span></span><span class="sig-name descname"><span class="pre">IterableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">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="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.iterable.iterable_abc.IterableABC" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.iterable.iterable_abc.</span></span><span class="sig-name descname"><span class="pre">IterableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.iterable.iterable_abc.IterableABC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryableABC</span></code></a></p>
<p>ABC to define functions on list</p>
<dl class="py method">
@@ -173,7 +185,7 @@
<dd><p>Converts :class: <cite>cpl_query.iterable.iterable_abc.IterableABC</cite> to :class: <cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite></p>
<dl class="simple">
<dt>Returns:</dt><dd><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite></p>
</dd>
</dl>
@@ -190,15 +202,16 @@
<h3>cpl-query CPL Queries<a class="headerlink" href="#cpl-query-cpl-queries" title="Permalink to this heading"></a></h3>
<p>CPL Python integrated Queries</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dt class="field-odd">copyright<span class="colon">:</span></dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2021 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
<dt class="field-even">license</dt>
<dt class="field-even">license<span class="colon">:</span></dt>
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.iterable.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.iterable.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.iterable.VersionInfo" title="Permalink to this definition"></a></dt>
@@ -223,7 +236,6 @@
</dd></dl>
</section>
</section>
</section>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Translation reference &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -27,11 +27,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -41,15 +45,49 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Translation reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_translation.translate_pipe">cpl_translation.translate_pipe</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_translation.translation_service">cpl_translation.translation_service</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_translation.translation_service_abc">cpl_translation.translation_service_abc</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_translation.translation_settings">cpl_translation.translation_settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_translation.translate_pipe">cpl_translation.translate_pipe</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#cpl_translation.translate_pipe.TranslatePipe"><code class="docutils literal notranslate"><span class="pre">TranslatePipe</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_translation.translate_pipe.TranslatePipe.transform"><code class="docutils literal notranslate"><span class="pre">TranslatePipe.transform()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_translation.translation_service">cpl_translation.translation_service</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#cpl_translation.translation_service.TranslationService"><code class="docutils literal notranslate"><span class="pre">TranslationService</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_translation.translation_service.TranslationService.load"><code class="docutils literal notranslate"><span class="pre">TranslationService.load()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_translation.translation_service.TranslationService.load_by_settings"><code class="docutils literal notranslate"><span class="pre">TranslationService.load_by_settings()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_translation.translation_service.TranslationService.set_default_lang"><code class="docutils literal notranslate"><span class="pre">TranslationService.set_default_lang()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_translation.translation_service.TranslationService.set_lang"><code class="docutils literal notranslate"><span class="pre">TranslationService.set_lang()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_translation.translation_service.TranslationService.translate"><code class="docutils literal notranslate"><span class="pre">TranslationService.translate()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_translation.translation_service_abc">cpl_translation.translation_service_abc</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#cpl_translation.translation_service_abc.TranslationServiceABC"><code class="docutils literal notranslate"><span class="pre">TranslationServiceABC</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_translation.translation_service_abc.TranslationServiceABC.load"><code class="docutils literal notranslate"><span class="pre">TranslationServiceABC.load()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_translation.translation_service_abc.TranslationServiceABC.load_by_settings"><code class="docutils literal notranslate"><span class="pre">TranslationServiceABC.load_by_settings()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_translation.translation_service_abc.TranslationServiceABC.set_default_lang"><code class="docutils literal notranslate"><span class="pre">TranslationServiceABC.set_default_lang()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_translation.translation_service_abc.TranslationServiceABC.set_lang"><code class="docutils literal notranslate"><span class="pre">TranslationServiceABC.set_lang()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_translation.translation_service_abc.TranslationServiceABC.translate"><code class="docutils literal notranslate"><span class="pre">TranslationServiceABC.translate()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_translation.translation_settings">cpl_translation.translation_settings</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#cpl_translation.translation_settings.TranslationSettings"><code class="docutils literal notranslate"><span class="pre">TranslationSettings</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_translation.translation_settings.TranslationSettings.default_language"><code class="docutils literal notranslate"><span class="pre">TranslationSettings.default_language</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_translation.translation_settings.TranslationSettings.languages"><code class="docutils literal notranslate"><span class="pre">TranslationSettings.languages</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
@@ -67,8 +105,8 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Translation reference</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Translation reference</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_translation.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -166,23 +204,13 @@
<span id="cpl-translation-translation-settings"></span><h2>cpl_translation.translation_settings<a class="headerlink" href="#module-cpl_translation.translation_settings" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_translation.translation_settings.TranslationSettings">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_translation.translation_settings.</span></span><span class="sig-name descname"><span class="pre">TranslationSettings</span></span><a class="headerlink" href="#cpl_translation.translation_settings.TranslationSettings" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_translation.translation_settings.</span></span><span class="sig-name descname"><span class="pre">TranslationSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">languages</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_lang</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_translation.translation_settings.TranslationSettings" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_translation.translation_settings.TranslationSettings.default_language">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">default_language</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_translation.translation_settings.TranslationSettings.default_language" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_translation.translation_settings.TranslationSettings.from_dict">
<span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_translation.translation_settings.TranslationSettings.from_dict" title="Permalink to this definition"></a></dt>
<dd><p>Converts attributes to dict</p>
<dl class="simple">
<dt>Parameter:</dt><dd><p>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_translation.translation_settings.TranslationSettings.languages">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">languages</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_translation.translation_settings.TranslationSettings.languages" title="Permalink to this definition"></a></dt>

182
docs/build/html/deprecated.html vendored Normal file
View File

@@ -0,0 +1,182 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Deprecated &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="CLI reference" href="cpl_cli.html" />
<link rel="prev" title="Contributing to CPL" href="contributing.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="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>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Deprecated</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#table-of-contents">Table of Contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="#configurationmodelabc-from-dict-method">ConfigurationModelABC from_dict method</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation 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="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="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Deprecated</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/deprecated.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">
<section id="deprecated">
<h1>Deprecated<a class="headerlink" href="#deprecated" title="Permalink to this heading"></a></h1>
<section id="table-of-contents">
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this heading"></a></h2>
<ol class="arabic simple">
<li><p><a class="reference internal" href="#ConfigurationModelABC-from_dict-method"><span class="xref myst">ConfigurationModelABC.from_dict</span></a></p></li>
</ol>
</section>
<section id="configurationmodelabc-from-dict-method">
<h2>ConfigurationModelABC from_dict method<a class="headerlink" href="#configurationmodelabc-from-dict-method" title="Permalink to this heading"></a></h2>
<p>We now process the configuration models directly in the configuration by recursive parameter parsing.</p>
<p>The JSONProcessor now goes through the JSON and the arguments of the <strong>init</strong> and links the attributes by name from the
JSON and the name of the keyword argument.
Now, based on the type, either simply assigns the value. With a <code class="docutils literal notranslate"><span class="pre">dict</span></code> the processor is called recursively and so the
JSON is processed further. This way nested ConfigurationModels can be processed.</p>
<p>For this the code must be adapted as follows:</p>
<p>From this:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>class<span class="w"> </span>VersionSettings<span class="o">(</span>ConfigurationModelABC<span class="o">)</span>:
<span class="w"> </span>def<span class="w"> </span>__init__<span class="o">(</span>self<span class="o">)</span>:
<span class="w"> </span>ConfigurationModelABC.__init__<span class="o">(</span>self<span class="o">)</span>
<span class="w"> </span>self.major:<span class="w"> </span>Optional<span class="o">[</span>str<span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;0&quot;</span>
<span class="w"> </span>self.minor:<span class="w"> </span>Optional<span class="o">[</span>str<span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;0&quot;</span>
<span class="w"> </span>self.micro:<span class="w"> </span>Optional<span class="o">[</span>str<span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;0&quot;</span>
<span class="w"> </span>def<span class="w"> </span>from_dict<span class="o">(</span>self,<span class="w"> </span>settings:<span class="w"> </span>dict<span class="o">)</span>:
<span class="w"> </span>self.major<span class="w"> </span><span class="o">=</span><span class="w"> </span>settings<span class="o">[</span><span class="s2">&quot;Major&quot;</span><span class="o">]</span>
<span class="w"> </span>self.minor<span class="w"> </span><span class="o">=</span><span class="w"> </span>settings<span class="o">[</span><span class="s2">&quot;Minor&quot;</span><span class="o">]</span>
<span class="w"> </span><span class="nv">micro</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>settings<span class="o">[</span><span class="s2">&quot;Micro&quot;</span><span class="o">]</span>
<span class="w"> </span><span class="k">if</span><span class="w"> </span>micro<span class="w"> </span>!<span class="o">=</span><span class="w"> </span><span class="s1">&#39;&#39;</span>:
<span class="w"> </span>self.micro<span class="w"> </span><span class="o">=</span><span class="w"> </span>micro
</pre></div>
</div>
<p>To this:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>class<span class="w"> </span>VersionSettings<span class="o">(</span>ConfigurationModelABC<span class="o">)</span>:
<span class="w"> </span>def<span class="w"> </span>__init__<span class="o">(</span>self,<span class="w"> </span>major:<span class="w"> </span><span class="nv">str</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>None,<span class="w"> </span>minor:<span class="w"> </span><span class="nv">str</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>None,<span class="w"> </span>micro:<span class="w"> </span><span class="nv">str</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>None<span class="o">)</span>:
<span class="w"> </span>ConfigurationModelABC.__init__<span class="o">(</span>self<span class="o">)</span>
<span class="w"> </span>self.major:<span class="w"> </span>Optional<span class="o">[</span>str<span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>major
<span class="w"> </span>self.minor:<span class="w"> </span>Optional<span class="o">[</span>str<span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>minor
<span class="w"> </span>self.micro:<span class="w"> </span>Optional<span class="o">[</span>str<span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>micro<span class="w"> </span><span class="k">if</span><span class="w"> </span>micro<span class="w"> </span>!<span class="o">=</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="w"> </span><span class="k">else</span><span class="w"> </span>None
</pre></div>
</div>
<p>This makes the <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict"><span class="xref myst py py-meth">from_dict</span></a> function obsolete.</p>
<p>A few rules must be observed:</p>
<ul class="simple">
<li><p>Only simple types can be processed
<br>
Wrong: <code class="docutils literal notranslate"><span class="pre">dict[str,</span> <span class="pre">str]</span></code>
<br>
Correct: <code class="docutils literal notranslate"><span class="pre">dict</span></code>
<br>
<br>
Incorrect: <code class="docutils literal notranslate"><span class="pre">list[str]</span></code>
<br>
Correct: <code class="docutils literal notranslate"><span class="pre">list</span></code></p></li>
<li><p>The arguments must be optional, i.e. created as kwargs
<br>
Incorrect: <code class="docutils literal notranslate"><span class="pre">def</span> <span class="pre">__init__(self,</span> <span class="pre">x:</span> <span class="pre">int,</span> <span class="pre">y:</span> <span class="pre">int)</span></code>
<br>
Correct: <code class="docutils literal notranslate"><span class="pre">def</span> <span class="pre">__init__(self,</span> <span class="pre">x:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">None,</span> <span class="pre">y:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">None)</span></code></p></li>
</ul>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="contributing.html" class="btn btn-neutral float-left" title="Contributing to CPL" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cpl_cli.html" class="btn btn-neutral float-right" title="CLI reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021 - 2023, Sven Heidemann.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

View File

@@ -10,11 +10,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" />
@@ -25,11 +25,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -39,6 +43,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -59,8 +64,8 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Index</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Index</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
@@ -278,6 +283,8 @@
<li><a href="cpl_core.console.html#cpl_core.console.background_color_enum.BackgroundColorEnum">BackgroundColorEnum (class in cpl_core.console.background_color_enum)</a>
</li>
<li><a href="cpl_core.console.html#cpl_core.console.console.Console.banner">banner() (cpl_core.console.console.Console class method)</a>
</li>
<li><a href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.base_func">base_func() (in module cpl_core.configuration.configuration_model_abc)</a>
</li>
<li><a href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.base_type">base_type (cpl_core.dependency_injection.service_descriptor.ServiceDescriptor property)</a>
</li>
@@ -1928,14 +1935,14 @@
</li>
<li><a href="cpl_core.utils.html#cpl_core.utils.string.String.first_to_upper">first_to_upper() (cpl_core.utils.string.String static method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="cpl_core.pipes.html#cpl_core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe">FirstCharToLowerPipe (class in cpl_core.pipes.first_char_to_lower_pipe)</a>
</li>
<li><a href="cpl_core.pipes.html#cpl_core.pipes.first_to_upper_pipe.FirstToUpperPipe">FirstToUpperPipe (class in cpl_core.pipes.first_to_upper_pipe)</a>
</li>
<li><a href="cpl_core.configuration.html#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum.Flag">Flag (cpl_core.configuration.argument_type_enum.ArgumentTypeEnum attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="cpl_core.configuration.html#cpl_core.configuration.flag_argument.FlagArgument">FlagArgument (class in cpl_core.configuration.flag_argument)</a>
</li>
<li><a href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC.for_each">for_each() (cpl_query.base.queryable_abc.QueryableABC method)</a>
@@ -1951,21 +1958,7 @@
<li><a href="cpl_core.console.html#cpl_core.console.foreground_color_enum.ForegroundColorEnum">ForegroundColorEnum (class in cpl_core.console.foreground_color_enum)</a>
</li>
<li><a href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict">from_dict() (cpl_core.configuration.configuration_model_abc.ConfigurationModelABC method)</a>
<ul>
<li><a href="cpl_core.database.html#cpl_core.database.database_settings.DatabaseSettings.from_dict">(cpl_core.database.database_settings.DatabaseSettings method)</a>
</li>
<li><a href="cpl_core.logging.html#cpl_core.logging.logging_settings.LoggingSettings.from_dict">(cpl_core.logging.logging_settings.LoggingSettings method)</a>
</li>
<li><a href="cpl_core.mailing.html#cpl_core.mailing.email_client_settings.EMailClientSettings.from_dict">(cpl_core.mailing.email_client_settings.EMailClientSettings method)</a>
</li>
<li><a href="cpl_core.time.html#cpl_core.time.time_format_settings.TimeFormatSettings.from_dict">(cpl_core.time.time_format_settings.TimeFormatSettings method)</a>
</li>
<li><a href="cpl_discord.configuration.html#cpl_discord.configuration.discord_bot_settings.DiscordBotSettings.from_dict">(cpl_discord.configuration.discord_bot_settings.DiscordBotSettings method)</a>
</li>
<li><a href="cpl_translation.html#cpl_translation.translation_settings.TranslationSettings.from_dict">(cpl_translation.translation_settings.TranslationSettings method)</a>
</li>
</ul></li>
<li><a href="cpl_core.console.html#cpl_core.console.console_call.ConsoleCall.function">function (cpl_core.console.console_call.ConsoleCall property)</a>
</li>
</ul></td>
@@ -3119,8 +3112,6 @@
<li><a href="cpl_discord.service.html#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_message_delete">(cpl_discord.service.discord_service_abc.DiscordServiceABC method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="cpl_discord.html#cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_message_edit">on_message_edit (cpl_discord.discord_event_types_enum.DiscordEventTypesEnum attribute)</a>
</li>
<li><a href="cpl_discord.events.html#cpl_discord.events.on_message_edit_abc.OnMessageEditABC.on_message_edit">on_message_edit() (cpl_discord.events.on_message_edit_abc.OnMessageEditABC method)</a>
@@ -3133,6 +3124,8 @@
</ul></li>
<li><a href="cpl_discord.html#cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_private_channel_create">on_private_channel_create (cpl_discord.discord_event_types_enum.DiscordEventTypesEnum attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="cpl_discord.events.html#cpl_discord.events.on_private_channel_create_abc.OnPrivateChannelCreateABC.on_private_channel_create">on_private_channel_create() (cpl_discord.events.on_private_channel_create_abc.OnPrivateChannelCreateABC method)</a>
<ul>
@@ -3267,6 +3260,26 @@
<li><a href="cpl_discord.service.html#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_resume">(cpl_discord.service.discord_service_abc.DiscordServiceABC method)</a>
</li>
</ul></li>
<li><a href="cpl_discord.html#cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_scheduled_event_create">on_scheduled_event_create (cpl_discord.discord_event_types_enum.DiscordEventTypesEnum attribute)</a>
</li>
<li><a href="cpl_discord.service.html#cpl_discord.service.discord_service.DiscordService.on_scheduled_event_create">on_scheduled_event_create() (cpl_discord.service.discord_service.DiscordService method)</a>
</li>
<li><a href="cpl_discord.html#cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_scheduled_event_delete">on_scheduled_event_delete (cpl_discord.discord_event_types_enum.DiscordEventTypesEnum attribute)</a>
</li>
<li><a href="cpl_discord.service.html#cpl_discord.service.discord_service.DiscordService.on_scheduled_event_delete">on_scheduled_event_delete() (cpl_discord.service.discord_service.DiscordService method)</a>
</li>
<li><a href="cpl_discord.html#cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_scheduled_event_update">on_scheduled_event_update (cpl_discord.discord_event_types_enum.DiscordEventTypesEnum attribute)</a>
</li>
<li><a href="cpl_discord.service.html#cpl_discord.service.discord_service.DiscordService.on_scheduled_event_update">on_scheduled_event_update() (cpl_discord.service.discord_service.DiscordService method)</a>
</li>
<li><a href="cpl_discord.html#cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_scheduled_event_user_add">on_scheduled_event_user_add (cpl_discord.discord_event_types_enum.DiscordEventTypesEnum attribute)</a>
</li>
<li><a href="cpl_discord.service.html#cpl_discord.service.discord_service.DiscordService.on_scheduled_event_user_add">on_scheduled_event_user_add() (cpl_discord.service.discord_service.DiscordService method)</a>
</li>
<li><a href="cpl_discord.html#cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_scheduled_event_user_remove">on_scheduled_event_user_remove (cpl_discord.discord_event_types_enum.DiscordEventTypesEnum attribute)</a>
</li>
<li><a href="cpl_discord.service.html#cpl_discord.service.discord_service.DiscordService.on_scheduled_event_user_remove">on_scheduled_event_user_remove() (cpl_discord.service.discord_service.DiscordService method)</a>
</li>
<li><a href="cpl_discord.html#cpl_discord.discord_event_types_enum.DiscordEventTypesEnum.on_typing">on_typing (cpl_discord.discord_event_types_enum.DiscordEventTypesEnum attribute)</a>
</li>
<li><a href="cpl_discord.events.html#cpl_discord.events.on_typing_abc.OnTypingABC.on_typing">on_typing() (cpl_discord.events.on_typing_abc.OnTypingABC method)</a>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Getting started &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -47,6 +51,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -67,8 +72,8 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Getting started</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Getting started</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/getting_started.rst.txt" rel="nofollow"> View page source</a>
</li>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Introduction to the CPL Docs &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -27,11 +27,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home"> Common Python Library
<a href="#" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -41,6 +45,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -61,8 +66,8 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home"></a> &raquo;</li>
<li>Introduction to the CPL Docs</li>
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Introduction to the CPL Docs</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -81,7 +86,7 @@
<ul class="simple">
<li><dl class="simple">
<dt>cpl-core</dt><dd><ul>
<li><p>Expandle</p></li>
<li><p>Expandable</p></li>
<li><dl class="simple">
<dt>Application base</dt><dd><ul>
<li><p>Standardized application classes</p></li>
@@ -236,6 +241,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Introduction to the CPL Docs &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -46,6 +50,7 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -66,8 +71,8 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Introduction to the CPL Docs</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Introduction to the CPL Docs</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/introduction.md.txt" rel="nofollow"> View page source</a>
</li>

File diff suppressed because it is too large Load Diff

Binary file not shown.

View File

@@ -10,11 +10,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -62,8 +67,8 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Python Module Index</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Python Module Index</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Getting started with CPL &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -54,6 +58,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -74,9 +79,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="getting_started.html">Getting started</a> &raquo;</li>
<li>Getting started with CPL</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="getting_started.html">Getting started</a></li>
<li class="breadcrumb-item active">Getting started with CPL</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/quickstart.md.txt" rel="nofollow"> View page source</a>
</li>
@@ -93,10 +98,10 @@
<section id="table-of-contents">
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this heading"></a></h2>
<ol class="arabic simple">
<li><p><span class="xref myst">Prerequisites</span></p></li>
<li><p><span class="xref myst">Create the project</span></p></li>
<li><p><span class="xref myst">Create a menu</span></p></li>
<li><p><span class="xref myst">Whats next</span></p></li>
<li><p><a class="reference internal" href="#prerequisites"><span class="xref myst">Prerequisites</span></a></p></li>
<li><p><a class="reference internal" href="#create-the-project"><span class="xref myst">Create the project</span></a></p></li>
<li><p><a class="reference internal" href="#create-a-menu"><span class="xref myst">Create a menu</span></a></p></li>
<li><p><a class="reference internal" href="#whats-next"><span class="xref myst">Whats next</span></a></p></li>
</ol>
</section>
<section id="prerequisites">

View File

@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<script src="_static/searchtools.js"></script>
<script src="_static/language_data.js"></script>
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="#" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -42,6 +46,7 @@
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -62,8 +67,8 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Search</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Search</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>

File diff suppressed because one or more lines are too long

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Setting up the local environment and workspace &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -58,6 +62,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -78,9 +83,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="getting_started.html">Getting started</a> &raquo;</li>
<li>Setting up the local environment and workspace</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="getting_started.html">Getting started</a></li>
<li class="breadcrumb-item active">Setting up the local environment and workspace</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/setup.md.txt" rel="nofollow"> View page source</a>
</li>
@@ -95,14 +100,14 @@
<section id="table-of-contents">
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this heading"></a></h2>
<ol class="arabic simple">
<li><p><span class="xref myst">Prerequisites</span></p></li>
<li><p><span class="xref myst">Install the package</span></p></li>
<li><p><span class="xref myst">Install the CLI</span></p></li>
<li><p><span class="xref myst">Install the query</span></p></li>
<li><p><span class="xref myst">Create a initial application</span></p></li>
<li><p><span class="xref myst">Create a initial library</span></p></li>
<li><p><span class="xref myst">Start the application</span></p></li>
<li><p><span class="xref myst">Whats next</span></p></li>
<li><p><a class="reference internal" href="#prerequisites"><span class="xref myst">Prerequisites</span></a></p></li>
<li><p><a class="reference internal" href="#install-the-package"><span class="xref myst">Install the package</span></a></p></li>
<li><p><a class="reference internal" href="#install-the-cli"><span class="xref myst">Install the CLI</span></a></p></li>
<li><p><a class="reference internal" href="#install-the-query"><span class="xref myst">Install the query</span></a></p></li>
<li><p><a class="reference internal" href="#create-initial-console-app"><span class="xref myst">Create a initial application</span></a></p></li>
<li><p><a class="reference internal" href="#create-initial-library"><span class="xref myst">Create a initial library</span></a></p></li>
<li><p><a class="reference internal" href="#start-the-app"><span class="xref myst">Start the application</span></a></p></li>
<li><p><a class="reference internal" href="#whats-next"><span class="xref myst">Whats next</span></a></p></li>
</ol>
</section>
<section id="prerequisites">

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Using appsettings.json &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -61,6 +65,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -81,10 +86,10 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="getting_started.html">Getting started</a> &raquo;</li>
<li><a href="tutorials.html">Tutorials</a> &raquo;</li>
<li>Using appsettings.json</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="getting_started.html">Getting started</a></li>
<li class="breadcrumb-item"><a href="tutorials.html">Tutorials</a></li>
<li class="breadcrumb-item active">Using appsettings.json</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/tutorials.appsettings.md.txt" rel="nofollow"> View page source</a>
</li>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Handle console arguments &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -61,6 +65,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -81,10 +86,10 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="getting_started.html">Getting started</a> &raquo;</li>
<li><a href="tutorials.html">Tutorials</a> &raquo;</li>
<li>Handle console arguments</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="getting_started.html">Getting started</a></li>
<li class="breadcrumb-item"><a href="tutorials.html">Tutorials</a></li>
<li class="breadcrumb-item active">Handle console arguments</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/tutorials.console-arguments.md.txt" rel="nofollow"> View page source</a>
</li>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Use cpl_core.console.Console &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -61,6 +65,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -81,10 +86,10 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="getting_started.html">Getting started</a> &raquo;</li>
<li><a href="tutorials.html">Tutorials</a> &raquo;</li>
<li>Use cpl_core.console.Console</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="getting_started.html">Getting started</a></li>
<li class="breadcrumb-item"><a href="tutorials.html">Tutorials</a></li>
<li class="breadcrumb-item active">Use cpl_core.console.Console</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/tutorials.console.md.txt" rel="nofollow"> View page source</a>
</li>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Create startup class &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -61,6 +65,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -81,10 +86,10 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="getting_started.html">Getting started</a> &raquo;</li>
<li><a href="tutorials.html">Tutorials</a> &raquo;</li>
<li>Create startup class</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="getting_started.html">Getting started</a></li>
<li class="breadcrumb-item"><a href="tutorials.html">Tutorials</a></li>
<li class="breadcrumb-item active">Create startup class</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/tutorials.create-startup.md.txt" rel="nofollow"> View page source</a>
</li>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Extend application &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -61,6 +65,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -81,10 +86,10 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="getting_started.html">Getting started</a> &raquo;</li>
<li><a href="tutorials.html">Tutorials</a> &raquo;</li>
<li>Extend application</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="getting_started.html">Getting started</a></li>
<li class="breadcrumb-item"><a href="tutorials.html">Tutorials</a></li>
<li class="breadcrumb-item active">Extend application</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/tutorials.extend-application.md.txt" rel="nofollow"> View page source</a>
</li>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Extend startup &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -61,6 +65,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -81,10 +86,10 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="getting_started.html">Getting started</a> &raquo;</li>
<li><a href="tutorials.html">Tutorials</a> &raquo;</li>
<li>Extend startup</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="getting_started.html">Getting started</a></li>
<li class="breadcrumb-item"><a href="tutorials.html">Tutorials</a></li>
<li class="breadcrumb-item active">Extend startup</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/tutorials.extend-startup.md.txt" rel="nofollow"> View page source</a>
</li>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Tutorials &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -58,6 +62,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -78,9 +83,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="getting_started.html">Getting started</a> &raquo;</li>
<li>Tutorials</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="getting_started.html">Getting started</a></li>
<li class="breadcrumb-item active">Tutorials</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/tutorials.rst.txt" rel="nofollow"> View page source</a>
</li>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Use builtin logger &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -61,6 +65,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -81,10 +86,10 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="getting_started.html">Getting started</a> &raquo;</li>
<li><a href="tutorials.html">Tutorials</a> &raquo;</li>
<li>Use builtin logger</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="getting_started.html">Getting started</a></li>
<li class="breadcrumb-item"><a href="tutorials.html">Tutorials</a></li>
<li class="breadcrumb-item active">Use builtin logger</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/tutorials.logging.md.txt" rel="nofollow"> View page source</a>
</li>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Send mails &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -61,6 +65,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -81,10 +86,10 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="getting_started.html">Getting started</a> &raquo;</li>
<li><a href="tutorials.html">Tutorials</a> &raquo;</li>
<li>Send mails</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="getting_started.html">Getting started</a></li>
<li class="breadcrumb-item"><a href="tutorials.html">Tutorials</a></li>
<li class="breadcrumb-item active">Send mails</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/tutorials.mail.md.txt" rel="nofollow"> View page source</a>
</li>

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Using cpl g &amp; cpl n templating &mdash; Common Python Library documentation</title>
@@ -11,11 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
@@ -28,11 +28,15 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
<a href="index.html" class="icon icon-home">
Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
@@ -64,6 +68,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
@@ -84,10 +89,10 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="getting_started.html">Getting started</a> &raquo;</li>
<li><a href="tutorials.html">Tutorials</a> &raquo;</li>
<li>Using cpl g &amp; cpl n templating</li>
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="getting_started.html">Getting started</a></li>
<li class="breadcrumb-item"><a href="tutorials.html">Tutorials</a></li>
<li class="breadcrumb-item active">Using cpl g &amp; cpl n templating</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/tutorials.templating.md.txt" rel="nofollow"> View page source</a>
</li>
@@ -102,9 +107,9 @@
<section id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><span class="xref myst">Prerequisites</span></p></li>
<li><p><span class="xref myst">Generate schematics</span></p></li>
<li><p><span class="xref myst">Project types</span></p></li>
<li><p><a class="reference internal" href="#prerequisites"><span class="xref myst">Prerequisites</span></a></p></li>
<li><p><a class="reference internal" href="#cpl-generate-scmatics"><span class="xref myst">Generate schematics</span></a></p></li>
<li><p><a class="reference internal" href="#cpl-new-project-types"><span class="xref myst">Project types</span></a></p></li>
</ul>
</section>
<section id="prerequisites">