674 lines
68 KiB
HTML
674 lines
68 KiB
HTML
<!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 name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>cpl_core.console package — 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 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 src="_static/doctools.js"></script>
|
||
<script src="_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="cpl_core.database package" href="cpl_core.database.html" />
|
||
<link rel="prev" title="cpl_core.configuration package" href="cpl_core.configuration.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="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"><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"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration package</a></li>
|
||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.console 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.console.background_color_enum">cpl_core.console.background_color_enum module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.console.console">cpl_core.console.console module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.console.console_call">cpl_core.console.console_call module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.console.foreground_color_enum">cpl_core.console.foreground_color_enum module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.console.spinner_thread">cpl_core.console.spinner_thread module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.console">Module contents</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html">cpl_core.database package</a></li>
|
||
<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"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment package</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html">cpl_core.logging package</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html">cpl_core.mailing package</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes package</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time package</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils package</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">cpl_discord package</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"></a> »</li>
|
||
<li><a href="cpl_core.html">API reference</a> »</li>
|
||
<li>cpl_core.console package</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="_sources/cpl_core.console.rst.txt" rel="nofollow"> View page source</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="cpl-core-console-package">
|
||
<h1>cpl_core.console package<a class="headerlink" href="#cpl-core-console-package" title="Permalink to this heading"></a></h1>
|
||
<section id="submodules">
|
||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||
</section>
|
||
<section id="module-cpl_core.console.background_color_enum">
|
||
<span id="cpl-core-console-background-color-enum-module"></span><h2>cpl_core.console.background_color_enum module<a class="headerlink" href="#module-cpl_core.console.background_color_enum" title="Permalink to this heading"></a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="cpl_core.console.background_color_enum.BackgroundColorEnum">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.console.background_color_enum.</span></span><span class="sig-name descname"><span class="pre">BackgroundColorEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
||
<p>An enumeration.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.background_color_enum.BackgroundColorEnum.blue">
|
||
<span class="sig-name descname"><span class="pre">blue</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'on_blue'</span></em><a class="headerlink" href="#cpl_core.console.background_color_enum.BackgroundColorEnum.blue" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.background_color_enum.BackgroundColorEnum.cyan">
|
||
<span class="sig-name descname"><span class="pre">cyan</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'on_cyan'</span></em><a class="headerlink" href="#cpl_core.console.background_color_enum.BackgroundColorEnum.cyan" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.background_color_enum.BackgroundColorEnum.default">
|
||
<span class="sig-name descname"><span class="pre">default</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'on_default'</span></em><a class="headerlink" href="#cpl_core.console.background_color_enum.BackgroundColorEnum.default" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.background_color_enum.BackgroundColorEnum.green">
|
||
<span class="sig-name descname"><span class="pre">green</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'on_green'</span></em><a class="headerlink" href="#cpl_core.console.background_color_enum.BackgroundColorEnum.green" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.background_color_enum.BackgroundColorEnum.grey">
|
||
<span class="sig-name descname"><span class="pre">grey</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'on_grey'</span></em><a class="headerlink" href="#cpl_core.console.background_color_enum.BackgroundColorEnum.grey" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.background_color_enum.BackgroundColorEnum.magenta">
|
||
<span class="sig-name descname"><span class="pre">magenta</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'on_magenta'</span></em><a class="headerlink" href="#cpl_core.console.background_color_enum.BackgroundColorEnum.magenta" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.background_color_enum.BackgroundColorEnum.red">
|
||
<span class="sig-name descname"><span class="pre">red</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'on_red'</span></em><a class="headerlink" href="#cpl_core.console.background_color_enum.BackgroundColorEnum.red" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.background_color_enum.BackgroundColorEnum.white">
|
||
<span class="sig-name descname"><span class="pre">white</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'on_white'</span></em><a class="headerlink" href="#cpl_core.console.background_color_enum.BackgroundColorEnum.white" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.background_color_enum.BackgroundColorEnum.yellow">
|
||
<span class="sig-name descname"><span class="pre">yellow</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'on_yellow'</span></em><a class="headerlink" href="#cpl_core.console.background_color_enum.BackgroundColorEnum.yellow" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="module-cpl_core.console.console">
|
||
<span id="cpl-core-console-console-module"></span><h2>cpl_core.console.console module<a class="headerlink" href="#module-cpl_core.console.console" title="Permalink to this heading"></a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.console.console.</span></span><span class="sig-name descname"><span class="pre">Console</span></span><a class="headerlink" href="#cpl_core.console.console.Console" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Useful functions for handling with input and output</p>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.background_color">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">background_color</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.console.console.Console.background_color" title="Permalink to this definition"></a></dt>
|
||
<dd><p>str(object=’’) -> str
|
||
str(bytes_or_buffer[, encoding[, errors]]) -> str</p>
|
||
<p>Create a new string object from the given object. If encoding or
|
||
errors is specified, then the object must expose a data buffer
|
||
that will be decoded using the given encoding and error handler.
|
||
Otherwise, returns the result of object.__str__() (if defined)
|
||
or repr(object).
|
||
encoding defaults to sys.getdefaultencoding().
|
||
errors defaults to ‘strict’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.banner">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">banner</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.banner" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Prints the string as a banner</p>
|
||
<dl class="simple">
|
||
<dt>Parameter:</dt><dd><dl class="simple">
|
||
<dt>string: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Message to print as banner</p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.clear">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.clear" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Clears the console</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.close">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.close" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Closes the application</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.color_reset">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">color_reset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.color_reset" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Resets the color settings</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.disable">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">disable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.disable" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Disables console interaction</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.enable">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">enable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.enable" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Enables console interaction</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.error">
|
||
<em class="property"><span class="pre">classmethod</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">string</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">tb</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.console.console.Console.error" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Prints an error with traceback</p>
|
||
<dl class="simple">
|
||
<dt>Parameter:</dt><dd><dl class="simple">
|
||
<dt>string: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Error message</p>
|
||
</dd>
|
||
<dt>tb: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Error traceback</p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.foreground_color">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">foreground_color</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.console.console.Console.foreground_color" title="Permalink to this definition"></a></dt>
|
||
<dd><p>str(object=’’) -> str
|
||
str(bytes_or_buffer[, encoding[, errors]]) -> str</p>
|
||
<p>Create a new string object from the given object. If encoding or
|
||
errors is specified, then the object must expose a data buffer
|
||
that will be decoded using the given encoding and error handler.
|
||
Otherwise, returns the result of object.__str__() (if defined)
|
||
or repr(object).
|
||
encoding defaults to sys.getdefaultencoding().
|
||
errors defaults to ‘strict’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.read">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">read</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span><span class="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> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl_core.console.console.Console.read" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Reads in line</p>
|
||
<dl class="simple">
|
||
<dt>Parameter:</dt><dd><dl class="simple">
|
||
<dt>output: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String to print before input</p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dt>Returns:</dt><dd><p>input()</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.read_line">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">read_line</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output</span></span><span class="p"><span class="pre">:</span></span><span class="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> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl_core.console.console.Console.read_line" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Reads in next line</p>
|
||
<dl class="simple">
|
||
<dt>Parameter:</dt><dd><dl class="simple">
|
||
<dt>output: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String to print before input</p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dt>Returns:</dt><dd><p>input()</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.reset_cursor_position">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">reset_cursor_position</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.reset_cursor_position" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Resets cursor position</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.select">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><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">char</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">options</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">header_foreground_color</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">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><span class="pre">ForegroundColorEnum</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">ForegroundColorEnum.default</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">header_background_color</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">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><span class="pre">BackgroundColorEnum</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">BackgroundColorEnum.default</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">option_foreground_color</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">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><span class="pre">ForegroundColorEnum</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">ForegroundColorEnum.default</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">option_background_color</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">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><span class="pre">BackgroundColorEnum</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">BackgroundColorEnum.default</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cursor_foreground_color</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">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><span class="pre">ForegroundColorEnum</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">ForegroundColorEnum.default</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cursor_background_color</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">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><span class="pre">BackgroundColorEnum</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">BackgroundColorEnum.default</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl_core.console.console.Console.select" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Prints select menu</p>
|
||
<dl class="simple">
|
||
<dt>Parameter:</dt><dd><dl class="simple">
|
||
<dt>char: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Character to show which element is selected</p>
|
||
</dd>
|
||
<dt>message: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Message or header of the selection</p>
|
||
</dd>
|
||
<dt>options: List[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</dt><dd><p>Selectable options</p>
|
||
</dd>
|
||
<dt>header_foreground_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.foreground_color_enum.ForegroundColorEnum</span></code></a>]</dt><dd><p>Foreground color of the header</p>
|
||
</dd>
|
||
<dt>header_background_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum</span></code></a>]</dt><dd><p>Background color of the header</p>
|
||
</dd>
|
||
<dt>option_foreground_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.foreground_color_enum.ForegroundColorEnum</span></code></a>]</dt><dd><p>Foreground color of the options</p>
|
||
</dd>
|
||
<dt>option_background_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum</span></code></a>]</dt><dd><p>Background color of the options</p>
|
||
</dd>
|
||
<dt>cursor_foreground_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.foreground_color_enum.ForegroundColorEnum</span></code></a>]</dt><dd><p>Foreground color of the cursor</p>
|
||
</dd>
|
||
<dt>cursor_background_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum</span></code></a>]</dt><dd><p>Background color of the cursor</p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dt>Returns:</dt><dd><p>Selected option as <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.set_background_color">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_background_color</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><span class="pre">BackgroundColorEnum</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.set_background_color" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Sets the background color</p>
|
||
<dl class="simple">
|
||
<dt>Parameter:</dt><dd><dl class="simple">
|
||
<dt>color: Union[<a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</dt><dd><p>Background color of the console</p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.set_cursor_position">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_cursor_position</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.set_cursor_position" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Sets cursor position</p>
|
||
<dl class="simple">
|
||
<dt>Parameter:</dt><dd><dl class="simple">
|
||
<dt>x: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>X coordinate</p>
|
||
</dd>
|
||
<dt>y: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>Y coordinate</p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.set_foreground_color">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_foreground_color</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><span class="pre">ForegroundColorEnum</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.set_foreground_color" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Sets the foreground color</p>
|
||
<dl class="simple">
|
||
<dt>Parameter:</dt><dd><dl class="simple">
|
||
<dt>color: Union[<a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</dt><dd><p>Foreground color of the console</p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.set_hold_back">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_hold_back</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">bool</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.set_hold_back" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.spinner">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">spinner</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">call</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text_foreground_color</span></span><span class="p"><span class="pre">:</span></span><span class="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">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><span class="pre">ForegroundColorEnum</span></a><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">spinner_foreground_color</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">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><span class="pre">ForegroundColorEnum</span></a><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">text_background_color</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">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><span class="pre">BackgroundColorEnum</span></a><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">spinner_background_color</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">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><span class="pre">BackgroundColorEnum</span></a><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="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_core.console.console.Console.spinner" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Shows spinner and calls given function, when function has ended the spinner stops</p>
|
||
<dl class="simple">
|
||
<dt>Parameter:</dt><dd><dl class="simple">
|
||
<dt>message: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Message of the spinner</p>
|
||
</dd>
|
||
<dt>call: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>Function to call</p>
|
||
</dd>
|
||
<dt>args: <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></dt><dd><p>Arguments of the function</p>
|
||
</dd>
|
||
<dt>text_foreground_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.foreground_color_enum.ForegroundColorEnum</span></code></a>]</dt><dd><p>Foreground color of the text</p>
|
||
</dd>
|
||
<dt>spinner_foreground_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.foreground_color_enum.ForegroundColorEnum</span></code></a>]</dt><dd><p>Foreground color of the spinner</p>
|
||
</dd>
|
||
<dt>text_background_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum</span></code></a>]</dt><dd><p>Background color of the text</p>
|
||
</dd>
|
||
<dt>spinner_background_color: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.background_color_enum.BackgroundColorEnum</span></code></a>]</dt><dd><p>Background color of the spinner</p>
|
||
</dd>
|
||
<dt>kwargs: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></dt><dd><p>Keyword arguments of the call</p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dt>Returns:</dt><dd><p>Return value of call</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.table">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">table</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></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="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></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.table" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Prints a table with header and values</p>
|
||
<dl class="simple">
|
||
<dt>Parameter:</dt><dd><dl class="simple">
|
||
<dt>header: List[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</dt><dd><p>Header of the table</p>
|
||
</dd>
|
||
<dt>values: List[List[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]]</dt><dd><p>Values of the table</p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.write">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">write</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="n"><span class="pre">end</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.write" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Prints in active line</p>
|
||
<dl class="simple">
|
||
<dt>Parameter:</dt><dd><dl class="simple">
|
||
<dt>args: <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></dt><dd><p>Elements to print</p>
|
||
</dd>
|
||
<dt>end: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Last character to print</p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.write_at">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">write_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.write_at" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Prints at given position</p>
|
||
<dl class="simple">
|
||
<dt>Parameter:</dt><dd><dl class="simple">
|
||
<dt>x: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>X coordinate</p>
|
||
</dd>
|
||
<dt>y: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>Y coordinate</p>
|
||
</dd>
|
||
<dt>args: <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></dt><dd><p>Elements to print</p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.write_line">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">write_line</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.write_line" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Prints to new line</p>
|
||
<dl class="simple">
|
||
<dt>Parameter:</dt><dd><dl class="simple">
|
||
<dt>args: <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></dt><dd><p>Elements to print</p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console.Console.write_line_at">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">write_line_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console.Console.write_line_at" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Prints new line at given position</p>
|
||
<dl class="simple">
|
||
<dt>Parameter:</dt><dd><dl class="simple">
|
||
<dt>x: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>X coordinate</p>
|
||
</dd>
|
||
<dt>y: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>Y coordinate</p>
|
||
</dd>
|
||
<dt>args: <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></dt><dd><p>Elements to print</p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="module-cpl_core.console.console_call">
|
||
<span id="cpl-core-console-console-call-module"></span><h2>cpl_core.console.console_call module<a class="headerlink" href="#module-cpl_core.console.console_call" title="Permalink to this heading"></a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console_call.ConsoleCall">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.console.console_call.</span></span><span class="sig-name descname"><span class="pre">ConsoleCall</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">function</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.console_call.ConsoleCall" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Represents a console call, for hold back when spinner is active</p>
|
||
<dl class="simple">
|
||
<dt>Parameter:</dt><dd><dl class="simple">
|
||
<dt>function: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>Function to call</p>
|
||
</dd>
|
||
<dt>args: <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></dt><dd><p>List of arguments</p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console_call.ConsoleCall.args">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">args</span></span><a class="headerlink" href="#cpl_core.console.console_call.ConsoleCall.args" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="cpl_core.console.console_call.ConsoleCall.function">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">function</span></span><a class="headerlink" href="#cpl_core.console.console_call.ConsoleCall.function" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="module-cpl_core.console.foreground_color_enum">
|
||
<span id="cpl-core-console-foreground-color-enum-module"></span><h2>cpl_core.console.foreground_color_enum module<a class="headerlink" href="#module-cpl_core.console.foreground_color_enum" title="Permalink to this heading"></a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="cpl_core.console.foreground_color_enum.ForegroundColorEnum">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.console.foreground_color_enum.</span></span><span class="sig-name descname"><span class="pre">ForegroundColorEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
||
<p>An enumeration.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.foreground_color_enum.ForegroundColorEnum.blue">
|
||
<span class="sig-name descname"><span class="pre">blue</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'blue'</span></em><a class="headerlink" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum.blue" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.foreground_color_enum.ForegroundColorEnum.cyan">
|
||
<span class="sig-name descname"><span class="pre">cyan</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cyan'</span></em><a class="headerlink" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum.cyan" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.foreground_color_enum.ForegroundColorEnum.default">
|
||
<span class="sig-name descname"><span class="pre">default</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'default'</span></em><a class="headerlink" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum.default" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.foreground_color_enum.ForegroundColorEnum.green">
|
||
<span class="sig-name descname"><span class="pre">green</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'green'</span></em><a class="headerlink" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum.green" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.foreground_color_enum.ForegroundColorEnum.grey">
|
||
<span class="sig-name descname"><span class="pre">grey</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'grey'</span></em><a class="headerlink" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum.grey" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.foreground_color_enum.ForegroundColorEnum.magenta">
|
||
<span class="sig-name descname"><span class="pre">magenta</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'magenta'</span></em><a class="headerlink" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum.magenta" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.foreground_color_enum.ForegroundColorEnum.red">
|
||
<span class="sig-name descname"><span class="pre">red</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'red'</span></em><a class="headerlink" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum.red" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.foreground_color_enum.ForegroundColorEnum.white">
|
||
<span class="sig-name descname"><span class="pre">white</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'white'</span></em><a class="headerlink" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum.white" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.foreground_color_enum.ForegroundColorEnum.yellow">
|
||
<span class="sig-name descname"><span class="pre">yellow</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'yellow'</span></em><a class="headerlink" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum.yellow" title="Permalink to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="module-cpl_core.console.spinner_thread">
|
||
<span id="cpl-core-console-spinner-thread-module"></span><h2>cpl_core.console.spinner_thread module<a class="headerlink" href="#module-cpl_core.console.spinner_thread" title="Permalink to this heading"></a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="cpl_core.console.spinner_thread.SpinnerThread">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.console.spinner_thread.</span></span><span class="sig-name descname"><span class="pre">SpinnerThread</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg_len</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">foreground_color</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.console.foreground_color_enum.ForegroundColorEnum" title="cpl_core.console.foreground_color_enum.ForegroundColorEnum"><span class="pre">ForegroundColorEnum</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">background_color</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.console.background_color_enum.BackgroundColorEnum" title="cpl_core.console.background_color_enum.BackgroundColorEnum"><span class="pre">BackgroundColorEnum</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.spinner_thread.SpinnerThread" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Thread</span></code></p>
|
||
<p>Thread to show spinner in terminal</p>
|
||
<dl class="simple">
|
||
<dt>Parameter:</dt><dd><dl class="simple">
|
||
<dt>msg_len: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>Length of the message</p>
|
||
</dd>
|
||
<dt>foreground_color: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.foreground_color.ForegroundColorEnum</span></code></dt><dd><p>Foreground color of the spinner</p>
|
||
</dd>
|
||
<dt>background_color: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.console.background_color.BackgroundColorEnum</span></code></dt><dd><p>Background color of the spinner</p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.spinner_thread.SpinnerThread.exit">
|
||
<span class="sig-name descname"><span class="pre">exit</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.spinner_thread.SpinnerThread.exit" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Stops the spinner</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.spinner_thread.SpinnerThread.run">
|
||
<span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_core.console.spinner_thread.SpinnerThread.run" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Entry point of thread, shows the spinner</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="cpl_core.console.spinner_thread.SpinnerThread.stop_spinning">
|
||
<span class="sig-name descname"><span class="pre">stop_spinning</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.console.spinner_thread.SpinnerThread.stop_spinning" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Stops the spinner</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="module-cpl_core.console">
|
||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_core.console" title="Permalink to this heading"></a></h2>
|
||
<section id="cpl-core-cpl-core">
|
||
<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>
|
||
<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>
|
||
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="cpl_core.console.VersionInfo">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.console.</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.console.VersionInfo" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.VersionInfo.major">
|
||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_core.console.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Alias for field number 0</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.VersionInfo.micro">
|
||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_core.console.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Alias for field number 2</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="cpl_core.console.VersionInfo.minor">
|
||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_core.console.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Alias for field number 1</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="cpl_core.configuration.html" class="btn btn-neutral float-left" title="cpl_core.configuration package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="cpl_core.database.html" class="btn btn-neutral float-right" title="cpl_core.database package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2021 - 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> |