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

547 lines
46 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" />
Updated docs
2023-02-20 15:55:20 +01:00
<title>cpl_core.logging package &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
2023-02-20 15:55:20 +01:00
<link rel="next" title="cpl_core.mailing package" href="cpl_core.mailing.html" />
<link rel="prev" title="cpl_core.environment package" href="cpl_core.environment.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">
Updated docs
2023-02-20 15:55:20 +01:00
<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"><a class="reference internal" href="cpl_core.console.html">cpl_core.console package</a></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 current"><a class="current reference internal" href="#">cpl_core.logging package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.logging.logger_abc">cpl_core.logging.logger_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.logging.logger_service">cpl_core.logging.logger_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.logging.logging_level_enum">cpl_core.logging.logging_level_enum module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.logging.logging_settings">cpl_core.logging.logging_settings module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.logging.logging_settings_name_enum">cpl_core.logging.logging_settings_name_enum module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.logging">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</ul>
</li>
</ul>
</li>
Updated docs
2023-02-20 15:55:20 +01:00
<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>
Updated docs
2022-12-04 00:50:24 +01:00
<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>
Updated docs
2023-02-20 15:55:20 +01:00
<li>cpl_core.logging package</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.logging.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
Updated docs
2023-02-20 15:55:20 +01:00
<section id="cpl-core-logging-package">
<h1>cpl_core.logging package<a class="headerlink" href="#cpl-core-logging-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>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<section id="module-cpl_core.logging.logger_abc">
Updated docs
2023-02-20 15:55:20 +01:00
<span id="cpl-core-logging-logger-abc-module"></span><h2>cpl_core.logging.logger_abc module<a class="headerlink" href="#module-cpl_core.logging.logger_abc" 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.logging.logger_abc.LoggerABC">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.logging.logger_abc.</span></span><span class="sig-name descname"><span class="pre">LoggerABC</span></span><a class="headerlink" href="#cpl_core.logging.logger_abc.LoggerABC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
Improved docs
2021-11-01 20:43:25 +01:00
<p>ABC for <a class="reference internal" href="#cpl_core.logging.logger_service.Logger" title="cpl_core.logging.logger_service.Logger"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.logging.logger_service.Logger</span></code></a></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.logging.logger_abc.LoggerABC.debug">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">debug</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_abc.LoggerABC.debug" title="Permalink to this definition"></a></dt>
Build docs
2021-05-17 17:55:20 +02:00
<dd><p>Writes a debug message</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
Build docs
2021-05-17 17:55:20 +02:00
<dt>name: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Message name</p>
</dd>
<dt>message: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Message string</p>
</dd>
</dl>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
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.logging.logger_abc.LoggerABC.error">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Exception</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_abc.LoggerABC.error" title="Permalink to this definition"></a></dt>
Build docs
2021-05-17 17:55:20 +02:00
<dd><p>Writes an error</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
Build docs
2021-05-17 17:55:20 +02:00
<dt>name: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Error name</p>
</dd>
<dt>message: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Error message</p>
</dd>
<dt>ex: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></dt><dd><p>Thrown exception</p>
</dd>
</dl>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
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.logging.logger_abc.LoggerABC.fatal">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fatal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Exception</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_abc.LoggerABC.fatal" title="Permalink to this definition"></a></dt>
Build docs
2021-05-17 17:55:20 +02:00
<dd><p>Writes an error and ends the program</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
Build docs
2021-05-17 17:55:20 +02:00
<dt>name: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Error name</p>
</dd>
<dt>message: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Error message</p>
</dd>
<dt>ex: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></dt><dd><p>Thrown exception</p>
</dd>
</dl>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
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.logging.logger_abc.LoggerABC.header">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">header</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.logging.logger_abc.LoggerABC.header" title="Permalink to this definition"></a></dt>
Build docs
2021-05-17 17:55:20 +02:00
<dd><p>Writes a header message</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
Build docs
2021-05-17 17:55:20 +02:00
<dt>string: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String to write as header</p>
</dd>
</dl>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
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.logging.logger_abc.LoggerABC.info">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_abc.LoggerABC.info" title="Permalink to this definition"></a></dt>
Build docs
2021-05-17 17:55:20 +02:00
<dd><p>Writes an information</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
Build docs
2021-05-17 17:55:20 +02:00
<dt>name: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Message name</p>
</dd>
<dt>message: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Message string</p>
</dd>
</dl>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
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.logging.logger_abc.LoggerABC.trace">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_abc.LoggerABC.trace" title="Permalink to this definition"></a></dt>
Build docs
2021-05-17 17:55:20 +02:00
<dd><p>Writes a trace message</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
Build docs
2021-05-17 17:55:20 +02:00
<dt>name: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Message name</p>
</dd>
<dt>message: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Message string</p>
</dd>
</dl>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
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.logging.logger_abc.LoggerABC.warn">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">warn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_abc.LoggerABC.warn" title="Permalink to this definition"></a></dt>
Build docs
2021-05-17 17:55:20 +02:00
<dd><p>Writes an warning</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
Build docs
2021-05-17 17:55:20 +02:00
<dt>name: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Message name</p>
</dd>
<dt>message: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Message string</p>
</dd>
</dl>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
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.logging.logger_service">
Updated docs
2023-02-20 15:55:20 +01:00
<span id="cpl-core-logging-logger-service-module"></span><h2>cpl_core.logging.logger_service module<a class="headerlink" href="#module-cpl_core.logging.logger_service" 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.logging.logger_service.Logger">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.logging.logger_service.</span></span><span class="sig-name descname"><span class="pre">Logger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">logging_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.logging.logging_settings.LoggingSettings" title="cpl_core.logging.logging_settings.LoggingSettings"><span class="pre">LoggingSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">time_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.time.html#cpl_core.time.time_format_settings.TimeFormatSettings" title="cpl_core.time.time_format_settings.TimeFormatSettings"><span class="pre">TimeFormatSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_service.Logger" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl_core.logging.logger_abc.LoggerABC" title="cpl_core.logging.logger_abc.LoggerABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">LoggerABC</span></code></a></p>
Build docs
2021-05-17 17:55:20 +02:00
<p>Service for logging</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
Improved docs
2021-11-01 20:43:25 +01:00
<dt>logging_settings: <a class="reference internal" href="#cpl_core.logging.logging_settings.LoggingSettings" title="cpl_core.logging.logging_settings.LoggingSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.logging.logging_settings.LoggingSettings</span></code></a></dt><dd><p>Settings for the logger</p>
Build docs
2021-05-17 17:55:20 +02:00
</dd>
Improved docs
2021-11-01 20:43:25 +01:00
<dt>time_format: <a class="reference internal" href="cpl_core.time.html#cpl_core.time.time_format_settings.TimeFormatSettings" title="cpl_core.time.time_format_settings.TimeFormatSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.time.time_format_settings.TimeFormatSettings</span></code></a></dt><dd><p>Time format settings</p>
Build docs
2021-05-17 17:55:20 +02:00
</dd>
Improved docs
2021-11-01 20:43:25 +01:00
<dt>env: <a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></code></a></dt><dd><p>Environment of the application</p>
Build docs
2021-05-17 17:55:20 +02:00
</dd>
</dl>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
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.logging.logger_service.Logger.create">
<span class="sig-name descname"><span class="pre">create</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">None</span></span></span><a class="headerlink" href="#cpl_core.logging.logger_service.Logger.create" title="Permalink to this definition"></a></dt>
Build docs
2021-05-17 17:55:20 +02:00
<dd><p>Creates path tree and logfile</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.logging.logger_service.Logger.debug">
<span class="sig-name descname"><span class="pre">debug</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_service.Logger.debug" title="Permalink to this definition"></a></dt>
Build docs
2021-05-17 17:55:20 +02:00
<dd><p>Writes a debug message</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
Build docs
2021-05-17 17:55:20 +02:00
<dt>name: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Message name</p>
</dd>
<dt>message: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Message string</p>
</dd>
</dl>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
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.logging.logger_service.Logger.error">
<span class="sig-name descname"><span class="pre">error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Exception</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_service.Logger.error" title="Permalink to this definition"></a></dt>
Build docs
2021-05-17 17:55:20 +02:00
<dd><p>Writes an error</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
Build docs
2021-05-17 17:55:20 +02:00
<dt>name: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Error name</p>
</dd>
<dt>message: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Error message</p>
</dd>
<dt>ex: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></dt><dd><p>Thrown exception</p>
</dd>
</dl>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
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.logging.logger_service.Logger.fatal">
<span class="sig-name descname"><span class="pre">fatal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Exception</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_service.Logger.fatal" title="Permalink to this definition"></a></dt>
Build docs
2021-05-17 17:55:20 +02:00
<dd><p>Writes an error and ends the program</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
Build docs
2021-05-17 17:55:20 +02:00
<dt>name: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Error name</p>
</dd>
<dt>message: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Error message</p>
</dd>
<dt>ex: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></dt><dd><p>Thrown exception</p>
</dd>
</dl>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
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.logging.logger_service.Logger.header">
<span class="sig-name descname"><span class="pre">header</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.logging.logger_service.Logger.header" title="Permalink to this definition"></a></dt>
Build docs
2021-05-17 17:55:20 +02:00
<dd><p>Writes a header message</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
Build docs
2021-05-17 17:55:20 +02:00
<dt>string: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>String to write as header</p>
</dd>
</dl>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
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.logging.logger_service.Logger.info">
<span class="sig-name descname"><span class="pre">info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_service.Logger.info" title="Permalink to this definition"></a></dt>
Build docs
2021-05-17 17:55:20 +02:00
<dd><p>Writes an information</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
Build docs
2021-05-17 17:55:20 +02:00
<dt>name: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Message name</p>
</dd>
<dt>message: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Message string</p>
</dd>
</dl>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
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.logging.logger_service.Logger.trace">
<span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_service.Logger.trace" title="Permalink to this definition"></a></dt>
Build docs
2021-05-17 17:55:20 +02:00
<dd><p>Writes a trace message</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
Build docs
2021-05-17 17:55:20 +02:00
<dt>name: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Message name</p>
</dd>
<dt>message: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Message string</p>
</dd>
</dl>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
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.logging.logger_service.Logger.warn">
<span class="sig-name descname"><span class="pre">warn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logger_service.Logger.warn" title="Permalink to this definition"></a></dt>
Build docs
2021-05-17 17:55:20 +02:00
<dd><p>Writes an warning</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
Build docs
2021-05-17 17:55:20 +02:00
<dt>name: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Message name</p>
</dd>
<dt>message: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Message string</p>
</dd>
</dl>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
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.logging.logging_level_enum">
Updated docs
2023-02-20 15:55:20 +01:00
<span id="cpl-core-logging-logging-level-enum-module"></span><h2>cpl_core.logging.logging_level_enum module<a class="headerlink" href="#module-cpl_core.logging.logging_level_enum" 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.logging.logging_level_enum.LoggingLevelEnum">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.logging.logging_level_enum.</span></span><span class="sig-name descname"><span class="pre">LoggingLevelEnum</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.logging.logging_level_enum.LoggingLevelEnum" 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>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<p>An enumeration.</p>
<dl class="py attribute">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.logging.logging_level_enum.LoggingLevelEnum.DEBUG">
<span class="sig-name descname"><span class="pre">DEBUG</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5</span></em><a class="headerlink" href="#cpl_core.logging.logging_level_enum.LoggingLevelEnum.DEBUG" 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 attribute">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.logging.logging_level_enum.LoggingLevelEnum.ERROR">
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#cpl_core.logging.logging_level_enum.LoggingLevelEnum.ERROR" 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 attribute">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.logging.logging_level_enum.LoggingLevelEnum.FATAL">
<span class="sig-name descname"><span class="pre">FATAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#cpl_core.logging.logging_level_enum.LoggingLevelEnum.FATAL" 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 attribute">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.logging.logging_level_enum.LoggingLevelEnum.INFO">
<span class="sig-name descname"><span class="pre">INFO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#cpl_core.logging.logging_level_enum.LoggingLevelEnum.INFO" 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 attribute">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.logging.logging_level_enum.LoggingLevelEnum.OFF">
<span class="sig-name descname"><span class="pre">OFF</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#cpl_core.logging.logging_level_enum.LoggingLevelEnum.OFF" 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 attribute">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.logging.logging_level_enum.LoggingLevelEnum.TRACE">
<span class="sig-name descname"><span class="pre">TRACE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">6</span></em><a class="headerlink" href="#cpl_core.logging.logging_level_enum.LoggingLevelEnum.TRACE" 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 attribute">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.logging.logging_level_enum.LoggingLevelEnum.WARN">
<span class="sig-name descname"><span class="pre">WARN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#cpl_core.logging.logging_level_enum.LoggingLevelEnum.WARN" title="Permalink to this definition"></a></dt>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<dd></dd></dl>
</dd></dl>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
</section>
<section id="module-cpl_core.logging.logging_settings">
Updated docs
2023-02-20 15:55:20 +01:00
<span id="cpl-core-logging-logging-settings-module"></span><h2>cpl_core.logging.logging_settings module<a class="headerlink" href="#module-cpl_core.logging.logging_settings" title="Permalink to this heading"></a></h2>
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.logging.logging_settings.LoggingSettings">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.logging.logging_settings.</span></span><span class="sig-name descname"><span class="pre">LoggingSettings</span></span><a class="headerlink" href="#cpl_core.logging.logging_settings.LoggingSettings" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
Build docs
2021-05-17 17:55:20 +02:00
<p>Representation of logging settings</p>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.logging.logging_settings.LoggingSettings.console">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">console</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.logging.logging_level_enum.LoggingLevelEnum" title="cpl_core.logging.logging_level_enum.LoggingLevelEnum"><span class="pre">LoggingLevelEnum</span></a></em><a class="headerlink" href="#cpl_core.logging.logging_settings.LoggingSettings.console" title="Permalink to this definition"></a></dt>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<dd></dd></dl>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.logging.logging_settings.LoggingSettings.filename">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">filename</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.logging.logging_settings.LoggingSettings.filename" title="Permalink to this definition"></a></dt>
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.logging.logging_settings.LoggingSettings.from_dict">
<span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.logging_settings.LoggingSettings.from_dict" title="Permalink to this definition"></a></dt>
Added docs for cpl.console
2021-05-16 17:42:09 +02:00
<dd><p>Converts attributes to dict</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><p>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
</dd>
</dl>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
</dd></dl>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.logging.logging_settings.LoggingSettings.level">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">level</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.logging.logging_level_enum.LoggingLevelEnum" title="cpl_core.logging.logging_level_enum.LoggingLevelEnum"><span class="pre">LoggingLevelEnum</span></a></em><a class="headerlink" href="#cpl_core.logging.logging_settings.LoggingSettings.level" title="Permalink to this definition"></a></dt>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<dd></dd></dl>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.logging.logging_settings.LoggingSettings.path">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.logging.logging_settings.LoggingSettings.path" title="Permalink to this definition"></a></dt>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<dd></dd></dl>
</dd></dl>
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
</section>
<section id="module-cpl_core.logging.logging_settings_name_enum">
Updated docs
2023-02-20 15:55:20 +01:00
<span id="cpl-core-logging-logging-settings-name-enum-module"></span><h2>cpl_core.logging.logging_settings_name_enum module<a class="headerlink" href="#module-cpl_core.logging.logging_settings_name_enum" 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.logging.logging_settings_name_enum.LoggingSettingsNameEnum">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.logging.logging_settings_name_enum.</span></span><span class="sig-name descname"><span class="pre">LoggingSettingsNameEnum</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.logging.logging_settings_name_enum.LoggingSettingsNameEnum" 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>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<p>An enumeration.</p>
<dl class="py attribute">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum.console_level">
<span class="sig-name descname"><span class="pre">console_level</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ConsoleLogLevel'</span></em><a class="headerlink" href="#cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum.console_level" 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 attribute">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum.file_level">
<span class="sig-name descname"><span class="pre">file_level</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'FileLogLevel'</span></em><a class="headerlink" href="#cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum.file_level" 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 attribute">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum.filename">
<span class="sig-name descname"><span class="pre">filename</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Filename'</span></em><a class="headerlink" href="#cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum.filename" 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 attribute">
Build docs and added tutorial files
2022-06-27 21:42:34 +02:00
<dt class="sig sig-object py" id="cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum.path">
<span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Path'</span></em><a class="headerlink" href="#cpl_core.logging.logging_settings_name_enum.LoggingSettingsNameEnum.path" title="Permalink to this definition"></a></dt>
Added first sphinx generated doc
2021-04-14 10:45:39 +02:00
<dd></dd></dl>
</dd></dl>
Updated docs
2023-02-20 15:55:20 +01:00
</section>
<section id="module-cpl_core.logging">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_core.logging" 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.logging.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.logging.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.logging.VersionInfo" title="Permalink to this definition"></a></dt>
<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.logging.VersionInfo.major">
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_core.logging.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.logging.VersionInfo.micro">
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_core.logging.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.logging.VersionInfo.minor">
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_core.logging.VersionInfo.minor" title="Permalink to this definition"></a></dt>
<dd><p>Alias for field number 1</p>
</dd></dl>
</dd></dl>
</section>
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">
Updated docs
2023-02-20 15:55:20 +01:00
<a href="cpl_core.environment.html" class="btn btn-neutral float-left" title="cpl_core.environment package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cpl_core.mailing.html" class="btn btn-neutral float-right" title="cpl_core.mailing package" 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