sh-edraft.de/sh_cpl
1
1
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects 1 Releases 12 Wiki Activity
2f8dc63cdc
sh_cpl/docs/build/html/cpl_core.utils.html

356 lines
26 KiB
HTML
Raw Normal View History

Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
Improved docs
2021-11-01 20:43:25 +01:00
<title>cpl_core.utils &mdash; Common Python Library documentation</title>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<script src="_static/doctools.js"></script>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<script src="_static/js/theme.js"></script>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Updated docs
2022-12-04 00:50:24 +01:00
<link rel="next" title="Discord reference" href="cpl_discord.html" />
Improved docs
2021-11-01 20:43:25 +01:00
<link rel="prev" title="cpl_core.time" href="cpl_core.time.html" />
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</head>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<body class="wy-body-for-nav">
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<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>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<ul class="current">
Added cli docs
2021-05-17 18:32:09 +02:00
<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>
Improved docs
2022-07-31 11:30:05 +02:00
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
Updated docs
2022-12-04 00:50:24 +01:00
<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">
Improved docs
2021-11-01 20:43:25 +01:00
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html">cpl_core.database</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html">cpl_core.logging</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html">cpl_core.mailing</a></li>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes</a></li>
Improved docs
2021-11-01 20:43:25 +01:00
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.utils</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.utils.credential_manager">cpl_core.utils.credential_manager</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.utils.pip">cpl_core.utils.pip</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.utils.string">cpl_core.utils.string</a></li>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</ul>
</li>
</ul>
</li>
Updated docs
2022-12-04 00:50:24 +01:00
<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>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</ul>
</div>
</div>
</nav>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<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">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<div role="navigation" aria-label="Page navigation">
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
Updated docs
2022-12-04 00:50:24 +01:00
<li><a href="cpl_core.html">API reference</a> &raquo;</li>
Improved docs
2021-11-01 20:43:25 +01:00
<li>cpl_core.utils</li>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<li class="wy-breadcrumbs-aside">
Improved docs
2021-11-01 20:43:25 +01:00
<a href="_sources/cpl_core.utils.rst.txt" rel="nofollow"> View page source</a>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<section id="cpl-core-utils">
<h1>cpl_core.utils<a class="headerlink" href="#cpl-core-utils" title="Permalink to this heading"></a></h1>
<section id="module-cpl_core.utils.credential_manager">
<span id="cpl-core-utils-credential-manager"></span><h2>cpl_core.utils.credential_manager<a class="headerlink" href="#module-cpl_core.utils.credential_manager" title="Permalink to this heading"></a></h2>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<dl class="py class">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.utils.credential_manager.CredentialManager">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.utils.credential_manager.</span></span><span class="sig-name descname"><span class="pre">CredentialManager</span></span><a class="headerlink" href="#cpl_core.utils.credential_manager.CredentialManager" title="Permalink to this definition"></a></dt>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
Added docs to cpl.utils
2021-05-17 18:07:08 +02:00
<p>Handles credential encryption and decryption</p>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<dl class="py method">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.utils.credential_manager.CredentialManager.build_string">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_string</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">credentials</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.utils.credential_manager.CredentialManager.build_string" title="Permalink to this definition"></a></dt>
Added docs to cpl.utils
2021-05-17 18:07:08 +02:00
<dd><p>Builds string with credentials in it</p>
<blockquote>
<div><dl class="simple">
<dt>string: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String in which the variable is replaced by credentials</p>
</dd>
<dt>credentials: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String to encode</p>
</dd>
</dl>
</div></blockquote>
<blockquote>
<div><p>Decoded string</p>
</div></blockquote>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</dd></dl>
<dl class="py method">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.utils.credential_manager.CredentialManager.decrypt">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">decrypt</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl_core.utils.credential_manager.CredentialManager.decrypt" title="Permalink to this definition"></a></dt>
Added docs to cpl.utils
2021-05-17 18:07:08 +02:00
<dd><p>Decode with base64</p>
<blockquote>
<div><dl class="simple">
<dt>string: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String to decode</p>
</dd>
</dl>
</div></blockquote>
<blockquote>
<div><p>Decoded string</p>
</div></blockquote>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</dd></dl>
<dl class="py method">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.utils.credential_manager.CredentialManager.encrypt">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">encrypt</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#cpl_core.utils.credential_manager.CredentialManager.encrypt" title="Permalink to this definition"></a></dt>
Added docs to cpl.utils
2021-05-17 18:07:08 +02:00
<dd><p>Encode with base64</p>
<blockquote>
<div><dl class="simple">
<dt>string: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String to encode</p>
</dd>
</dl>
</div></blockquote>
<blockquote>
<div><p>Encoded string</p>
</div></blockquote>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</dd></dl>
</dd></dl>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
</section>
<section id="module-cpl_core.utils.pip">
<span id="cpl-core-utils-pip"></span><h2>cpl_core.utils.pip<a class="headerlink" href="#module-cpl_core.utils.pip" title="Permalink to this heading"></a></h2>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<dl class="py class">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.utils.pip.Pip">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.utils.pip.</span></span><span class="sig-name descname"><span class="pre">Pip</span></span><a class="headerlink" href="#cpl_core.utils.pip.Pip" title="Permalink to this definition"></a></dt>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Executes pip commands</p>
<dl class="py method">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.utils.pip.Pip.get_executable">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_executable</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">str</span></span></span><a class="headerlink" href="#cpl_core.utils.pip.Pip.get_executable" title="Permalink to this definition"></a></dt>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<dd></dd></dl>
<dl class="py method">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.utils.pip.Pip.get_outdated">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_outdated</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">bytes</span></span></span><a class="headerlink" href="#cpl_core.utils.pip.Pip.get_outdated" title="Permalink to this definition"></a></dt>
Added docs to cpl.utils
2021-05-17 18:07:08 +02:00
<dd><p>Gets table of outdated packages</p>
<blockquote>
<div><p>Bytes string of the command result</p>
</div></blockquote>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</dd></dl>
<dl class="py method">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<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>
Added docs to cpl.utils
2021-05-17 18:07:08 +02:00
<dd><p>Gets given package py local pip list</p>
<blockquote>
<div><p>package: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</div></blockquote>
<blockquote>
<div><p>The package name as string</p>
</div></blockquote>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</dd></dl>
<dl class="py method">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<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>
Added docs to cpl.utils
2021-05-17 18:07:08 +02:00
<dd><p>Installs given package</p>
<blockquote>
<div><dl class="simple">
<dt>package: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>The name of the package</p>
</dd>
<dt>args: <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></dt><dd><p>Arguments for the command</p>
</dd>
<dt>source: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Extra index URL</p>
</dd>
<dt>stdout: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Stdout of subprocess.run</p>
</dd>
<dt>stderr: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Stderr of subprocess.run</p>
</dd>
</dl>
</div></blockquote>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</dd></dl>
<dl class="py method">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.utils.pip.Pip.reset_executable">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">reset_executable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.utils.pip.Pip.reset_executable" title="Permalink to this definition"></a></dt>
Added docs to cpl.utils
2021-05-17 18:07:08 +02:00
<dd><p>Resets the executable to system standard</p>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</dd></dl>
<dl class="py method">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.utils.pip.Pip.set_executable">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_executable</span></span><span class="sig-paren">(</span><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">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.utils.pip.Pip.set_executable" title="Permalink to this definition"></a></dt>
Added docs to cpl.utils
2021-05-17 18:07:08 +02:00
<dd><p>Sets the executable</p>
<blockquote>
<div><dl class="simple">
<dt>executable: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>The python command</p>
</dd>
</dl>
</div></blockquote>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</dd></dl>
<dl class="py method">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.utils.pip.Pip.uninstall">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uninstall</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="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.uninstall" title="Permalink to this definition"></a></dt>
Added docs to cpl.utils
2021-05-17 18:07:08 +02:00
<dd><p>Uninstalls given package</p>
<blockquote>
<div><dl class="simple">
<dt>package: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>The name of the package</p>
</dd>
<dt>stdout: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Stdout of subprocess.run</p>
</dd>
<dt>stderr: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Stderr of subprocess.run</p>
</dd>
</dl>
</div></blockquote>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</dd></dl>
</dd></dl>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
</section>
<section id="module-cpl_core.utils.string">
<span id="cpl-core-utils-string"></span><h2>cpl_core.utils.string<a class="headerlink" href="#module-cpl_core.utils.string" title="Permalink to this heading"></a></h2>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<dl class="py class">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.utils.string.String">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.utils.string.</span></span><span class="sig-name descname"><span class="pre">String</span></span><a class="headerlink" href="#cpl_core.utils.string.String" title="Permalink to this definition"></a></dt>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Useful functions for strings</p>
<dl class="py method">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.utils.string.String.convert_to_camel_case">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">convert_to_camel_case</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</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></span><a class="headerlink" href="#cpl_core.utils.string.String.convert_to_camel_case" title="Permalink to this definition"></a></dt>
Added docs to cpl.utils
2021-05-17 18:07:08 +02:00
<dd><p>Converts string to camel case</p>
<blockquote>
<div><dl class="simple">
<dt>chars: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String to convert</p>
</dd>
</dl>
</div></blockquote>
<blockquote>
<div><p>String converted to CamelCase</p>
</div></blockquote>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</dd></dl>
<dl class="py method">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.utils.string.String.convert_to_snake_case">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">convert_to_snake_case</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</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></span><a class="headerlink" href="#cpl_core.utils.string.String.convert_to_snake_case" title="Permalink to this definition"></a></dt>
Added docs to cpl.utils
2021-05-17 18:07:08 +02:00
<dd><p>Converts string to snake case</p>
<blockquote>
<div><dl class="simple">
<dt>chars: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String to convert</p>
</dd>
</dl>
</div></blockquote>
<blockquote>
<div><p>String converted to snake_case</p>
</div></blockquote>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</dd></dl>
<dl class="py method">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.utils.string.String.first_to_lower">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">first_to_lower</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</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></span><a class="headerlink" href="#cpl_core.utils.string.String.first_to_lower" title="Permalink to this definition"></a></dt>
Added docs to cpl.utils
2021-05-17 18:07:08 +02:00
<dd><p>Converts first char to lower</p>
<blockquote>
<div><dl class="simple">
<dt>chars: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String to convert</p>
</dd>
</dl>
</div></blockquote>
<blockquote>
<div><p>String with first char as lower</p>
</div></blockquote>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</dd></dl>
<dl class="py method">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.utils.string.String.first_to_upper">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">first_to_upper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</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></span><a class="headerlink" href="#cpl_core.utils.string.String.first_to_upper" title="Permalink to this definition"></a></dt>
Added docs to cpl.utils
2021-05-17 18:07:08 +02:00
<dd><p>Converts first char to upper</p>
<blockquote>
<div><dl class="simple">
<dt>chars: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String to convert</p>
</dd>
</dl>
</div></blockquote>
<blockquote>
<div><p>String with first char as upper</p>
</div></blockquote>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</dd></dl>
<dl class="py method">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.utils.string.String.random_string">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">random_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chars</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">length</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">str</span></span></span><a class="headerlink" href="#cpl_core.utils.string.String.random_string" title="Permalink to this definition"></a></dt>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<dd><p>Creates random string by given chars and length</p>
Added docs to cpl.utils
2021-05-17 18:07:08 +02:00
<blockquote>
<div><p>String of random chars</p>
</div></blockquote>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</dd></dl>
</dd></dl>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
</section>
</section>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</div>
</div>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
Build new docs
2021-12-02 08:20:38 +01:00
<a href="cpl_core.time.html" class="btn btn-neutral float-left" title="cpl_core.time" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
Updated docs
2022-12-04 00:50:24 +01:00
<a href="cpl_discord.html" class="btn btn-neutral float-right" title="Discord reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</div>
<hr/>
<div role="contentinfo">
Updated docs
2022-12-04 00:50:24 +01:00
<p>&#169; Copyright 2021 - 2023, Sven Heidemann.</p>
Build new docs
2021-12-02 08:20:38 +01:00
</div>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
provided by <a href="https://readthedocs.org">Read the Docs</a>.
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</footer>
</div>
</div>
</section>
</div>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<script>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
</script>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</body>
</html>
Reference in New Issue Copy Permalink