Build docs
This commit is contained in:
parent
fa5655414a
commit
8d4597705d
BIN
docs/build/doctrees/cpl.dependency_injection.doctree
vendored
BIN
docs/build/doctrees/cpl.dependency_injection.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl.environment.doctree
vendored
BIN
docs/build/doctrees/cpl.environment.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl.logging.doctree
vendored
BIN
docs/build/doctrees/cpl.logging.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl.mailing.doctree
vendored
BIN
docs/build/doctrees/cpl.mailing.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl.time.doctree
vendored
BIN
docs/build/doctrees/cpl.time.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/environment.pickle
vendored
BIN
docs/build/doctrees/environment.pickle
vendored
Binary file not shown.
83
docs/build/html/cpl.dependency_injection.html
vendored
83
docs/build/html/cpl.dependency_injection.html
vendored
|
|
@ -189,8 +189,12 @@
|
|||
<code class="sig-name descname"><span class="pre">add_db_context</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_context_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl.database.context.html#cpl.database.context.database_context_abc.DatabaseContextABC" title="cpl.database.context.database_context_abc.DatabaseContextABC"><span class="pre">cpl.database.context.database_context_abc.DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.database.html#cpl.database.database_settings.DatabaseSettings" title="cpl.database.database_settings.DatabaseSettings"><span class="pre">cpl.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.dependency_injection.service_collection.ServiceCollection.add_db_context" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds database context</p>
|
||||
<blockquote>
|
||||
<div><p>db_context: Type[<a class="reference internal" href="cpl.database.context.html#cpl.database.context.database_context_abc.DatabaseContextABC" title="cpl.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.context.database_context_abc.DatabaseContextABC</span></code></a>]
|
||||
db_settings: <a class="reference internal" href="cpl.database.html#cpl.database.database_settings.DatabaseSettings" title="cpl.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.database_settings.DatabaseSettings</span></code></a></p>
|
||||
<div><dl class="simple">
|
||||
<dt>db_context: Type[<a class="reference internal" href="cpl.database.context.html#cpl.database.context.database_context_abc.DatabaseContextABC" title="cpl.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database context</p>
|
||||
</dd>
|
||||
<dt>db_settings: <a class="reference internal" href="cpl.database.html#cpl.database.database_settings.DatabaseSettings" title="cpl.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.database_settings.DatabaseSettings</span></code></a></dt><dd><p>Database settings</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
|
|
@ -205,8 +209,12 @@ db_settings: <a class="reference internal" href="cpl.database.html#cpl.database.
|
|||
<code class="sig-name descname"><span class="pre">add_scoped</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.dependency_injection.service_collection.ServiceCollection.add_scoped" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds a service with scoped lifetime</p>
|
||||
<blockquote>
|
||||
<div><p>service_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code>
|
||||
service: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
||||
<div><dl class="simple">
|
||||
<dt>service_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></dt><dd><p>Type of the service</p>
|
||||
</dd>
|
||||
<dt>service: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>Object of the service</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
|
|
@ -215,8 +223,12 @@ service: <code class="xref py py-class docutils literal notranslate"><span class
|
|||
<code class="sig-name descname"><span class="pre">add_singleton</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">,</span> </span><span class="pre">object</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">,</span> </span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.dependency_injection.service_collection.ServiceCollection.add_singleton" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds a service with singleton lifetime</p>
|
||||
<blockquote>
|
||||
<div><p>service_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code>
|
||||
service: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
||||
<div><dl class="simple">
|
||||
<dt>service_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></dt><dd><p>Type of the service</p>
|
||||
</dd>
|
||||
<dt>service: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>Object of the service</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
|
|
@ -225,8 +237,12 @@ service: <code class="xref py py-class docutils literal notranslate"><span class
|
|||
<code class="sig-name descname"><span class="pre">add_transient</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.dependency_injection.service_collection.ServiceCollection.add_transient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds a service with transient lifetime</p>
|
||||
<blockquote>
|
||||
<div><p>service_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code>
|
||||
service: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
||||
<div><dl class="simple">
|
||||
<dt>service_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></dt><dd><p>Type of the service</p>
|
||||
</dd>
|
||||
<dt>service: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>Object of the service</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
|
|
@ -254,8 +270,12 @@ service: <code class="xref py py-class docutils literal notranslate"><span class
|
|||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_db_context</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db_context</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl.database.context.html#cpl.database.context.database_context_abc.DatabaseContextABC" title="cpl.database.context.database_context_abc.DatabaseContextABC"><span class="pre">cpl.database.context.database_context_abc.DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.database.html#cpl.database.database_settings.DatabaseSettings" title="cpl.database.database_settings.DatabaseSettings"><span class="pre">cpl.database.database_settings.DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.dependency_injection.service_collection_abc.ServiceCollectionABC.add_db_context" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds database context</p>
|
||||
<blockquote>
|
||||
<div><p>db_context: Type[<a class="reference internal" href="cpl.database.context.html#cpl.database.context.database_context_abc.DatabaseContextABC" title="cpl.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.context.database_context_abc.DatabaseContextABC</span></code></a>]
|
||||
db_settings: <a class="reference internal" href="cpl.database.html#cpl.database.database_settings.DatabaseSettings" title="cpl.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.database_settings.DatabaseSettings</span></code></a></p>
|
||||
<div><dl class="simple">
|
||||
<dt>db_context: Type[<a class="reference internal" href="cpl.database.context.html#cpl.database.context.database_context_abc.DatabaseContextABC" title="cpl.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database context</p>
|
||||
</dd>
|
||||
<dt>db_settings: <a class="reference internal" href="cpl.database.html#cpl.database.database_settings.DatabaseSettings" title="cpl.database.database_settings.DatabaseSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.database_settings.DatabaseSettings</span></code></a></dt><dd><p>Database settings</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
|
|
@ -270,8 +290,12 @@ db_settings: <a class="reference internal" href="cpl.database.html#cpl.database.
|
|||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_scoped</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds a service with scoped lifetime</p>
|
||||
<blockquote>
|
||||
<div><p>service_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code>
|
||||
service: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
||||
<div><dl class="simple">
|
||||
<dt>service_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></dt><dd><p>Type of the service</p>
|
||||
</dd>
|
||||
<dt>service: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>Object of the service</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
|
|
@ -280,8 +304,12 @@ service: <code class="xref py py-class docutils literal notranslate"><span class
|
|||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_singleton</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds a service with singleton lifetime</p>
|
||||
<blockquote>
|
||||
<div><p>service_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code>
|
||||
service: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
||||
<div><dl class="simple">
|
||||
<dt>service_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></dt><dd><p>Type of the service</p>
|
||||
</dd>
|
||||
<dt>service: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>Object of the service</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
|
|
@ -290,8 +318,12 @@ service: <code class="xref py py-class docutils literal notranslate"><span class
|
|||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_transient</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds a service with transient lifetime</p>
|
||||
<blockquote>
|
||||
<div><p>service_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code>
|
||||
service: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
||||
<div><dl class="simple">
|
||||
<dt>service_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></dt><dd><p>Type of the service</p>
|
||||
</dd>
|
||||
<dt>service: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>Object of the service</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
|
|
@ -315,8 +347,12 @@ service: <code class="xref py py-class docutils literal notranslate"><span class
|
|||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>Descriptor of a service</p>
|
||||
<blockquote>
|
||||
<div><p>implementation: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>, Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code>]]
|
||||
lifetime: <a class="reference internal" href="#cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum</span></code></a></p>
|
||||
<div><dl class="simple">
|
||||
<dt>implementation: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>, Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code>]]</dt><dd><p>Object or type of service</p>
|
||||
</dd>
|
||||
<dt>lifetime: <a class="reference internal" href="#cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum</span></code></a></dt><dd><p>Lifetime of the service</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<dl class="py method">
|
||||
<dt id="cpl.dependency_injection.service_descriptor.ServiceDescriptor.implementation">
|
||||
|
|
@ -369,9 +405,14 @@ lifetime: <a class="reference internal" href="#cpl.dependency_injection.service_
|
|||
<dd><p>Bases: <a class="reference internal" href="#cpl.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
<p>Provider for the services</p>
|
||||
<blockquote>
|
||||
<div><p>service_descriptors: list[<a class="reference internal" href="#cpl.dependency_injection.service_descriptor.ServiceDescriptor" title="cpl.dependency_injection.service_descriptor.ServiceDescriptor"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.dependency_injection.service_descriptor.ServiceDescriptor</span></code></a>]
|
||||
config: <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></code></a>
|
||||
db_context: Optional[<a class="reference internal" href="cpl.database.context.html#cpl.database.context.database_context_abc.DatabaseContextABC" title="cpl.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</p>
|
||||
<div><dl class="simple">
|
||||
<dt>service_descriptors: list[<a class="reference internal" href="#cpl.dependency_injection.service_descriptor.ServiceDescriptor" title="cpl.dependency_injection.service_descriptor.ServiceDescriptor"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.dependency_injection.service_descriptor.ServiceDescriptor</span></code></a>]</dt><dd><p>Descriptor of the service</p>
|
||||
</dd>
|
||||
<dt>config: <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_abc.ConfigurationABC" title="cpl.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_abc.ConfigurationABC</span></code></a></dt><dd><p>CPL Configuration</p>
|
||||
</dd>
|
||||
<dt>db_context: Optional[<a class="reference internal" href="cpl.database.context.html#cpl.database.context.database_context_abc.DatabaseContextABC" title="cpl.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database representation</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<dl class="py method">
|
||||
<dt id="cpl.dependency_injection.service_provider.ServiceProvider.build_service">
|
||||
|
|
|
|||
45
docs/build/html/cpl.environment.html
vendored
45
docs/build/html/cpl.environment.html
vendored
|
|
@ -180,6 +180,10 @@
|
|||
<dt id="cpl.environment.application_environment.ApplicationEnvironment">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.environment.application_environment.</span></code><code class="sig-name descname"><span class="pre">ApplicationEnvironment</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="pre">name:</span> <span class="pre">cpl.environment.environment_name_enum.EnvironmentNameEnum</span> <span class="pre">=</span> <span class="pre"><EnvironmentNameEnum.production:</span> <span class="pre">'production'></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.environment.application_environment.ApplicationEnvironment" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></code></a></p>
|
||||
<p>Represents environment of the application</p>
|
||||
<blockquote>
|
||||
<div><p>name: <a class="reference internal" href="#cpl.environment.environment_name_enum.EnvironmentNameEnum" title="cpl.environment.environment_name_enum.EnvironmentNameEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.environment.environment_name_enum.EnvironmentNameEnum</span></code></a></p>
|
||||
</div></blockquote>
|
||||
<dl class="py method">
|
||||
<dt id="cpl.environment.application_environment.ApplicationEnvironment.application_name">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">application_name</span></code><a class="headerlink" href="#cpl.environment.application_environment.ApplicationEnvironment.application_name" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -218,17 +222,25 @@
|
|||
<dl class="py method">
|
||||
<dt id="cpl.environment.application_environment.ApplicationEnvironment.set_runtime_directory">
|
||||
<code class="sig-name descname"><span class="pre">set_runtime_directory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">runtime_directory</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.environment.application_environment.ApplicationEnvironment.set_runtime_directory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets the current runtime directory
|
||||
:param runtime_directory:
|
||||
:return:</p>
|
||||
<dd><p>Sets the current runtime directory</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>runtime_directory: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Path of the runtime directory</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.environment.application_environment.ApplicationEnvironment.set_working_directory">
|
||||
<code class="sig-name descname"><span class="pre">set_working_directory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">working_directory</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.environment.application_environment.ApplicationEnvironment.set_working_directory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets the current working directory
|
||||
:param working_directory:
|
||||
:return:</p>
|
||||
<dd><p>Sets the current working directory</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>working_directory: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Path of the current working directory</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
@ -250,6 +262,7 @@
|
|||
<dt id="cpl.environment.application_environment_abc.ApplicationEnvironmentABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.environment.application_environment_abc.</span></code><code class="sig-name descname"><span class="pre">ApplicationEnvironmentABC</span></code><a class="headerlink" href="#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
|
||||
<p>ABC of the class <a class="reference internal" href="#cpl.environment.application_environment.ApplicationEnvironment" title="cpl.environment.application_environment.ApplicationEnvironment"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.environment.application_environment.ApplicationEnvironment</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl.environment.application_environment_abc.ApplicationEnvironmentABC.application_name">
|
||||
<em class="property"><span class="pre">abstract</span> <span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">application_name</span></code><a class="headerlink" href="#cpl.environment.application_environment_abc.ApplicationEnvironmentABC.application_name" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -288,17 +301,25 @@
|
|||
<dl class="py method">
|
||||
<dt id="cpl.environment.application_environment_abc.ApplicationEnvironmentABC.set_runtime_directory">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">set_runtime_directory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">runtime_directory</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.environment.application_environment_abc.ApplicationEnvironmentABC.set_runtime_directory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets the current runtime directory
|
||||
:param runtime_directory:
|
||||
:return:</p>
|
||||
<dd><p>Sets the current runtime directory</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>runtime_directory: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Path of the runtime directory</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.environment.application_environment_abc.ApplicationEnvironmentABC.set_working_directory">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">set_working_directory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">working_directory</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.environment.application_environment_abc.ApplicationEnvironmentABC.set_working_directory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets the current working directory
|
||||
:param working_directory:
|
||||
:return:</p>
|
||||
<dd><p>Sets the current working directory</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>working_directory: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Path of the current working directory</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
|
|||
204
docs/build/html/cpl.logging.html
vendored
204
docs/build/html/cpl.logging.html
vendored
|
|
@ -182,68 +182,105 @@
|
|||
<dt id="cpl.logging.logger_abc.LoggerABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.logging.logger_abc.</span></code><code class="sig-name descname"><span class="pre">LoggerABC</span></code><a class="headerlink" href="#cpl.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.ABC</span></code></p>
|
||||
<p>ABC for <a class="reference internal" href="#cpl.logging.logger_service.Logger" title="cpl.logging.logger_service.Logger"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.logging.logger_service.Logger</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl.logging.logger_abc.LoggerABC.debug">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">debug</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.logging.logger_abc.LoggerABC.debug" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Writes a debug message
|
||||
:param name:
|
||||
:param message:
|
||||
:return:</p>
|
||||
<dd><p>Writes a debug message</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<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>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.logging.logger_abc.LoggerABC.error">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">error</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Exception</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.logging.logger_abc.LoggerABC.error" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Writes an error
|
||||
:param name:
|
||||
:param message:
|
||||
:param ex:
|
||||
:return:</p>
|
||||
<dd><p>Writes an error</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<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>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.logging.logger_abc.LoggerABC.fatal">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">fatal</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Exception</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.logging.logger_abc.LoggerABC.fatal" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Writes an error and exits
|
||||
:param name:
|
||||
:param message:
|
||||
:param ex:
|
||||
:return:</p>
|
||||
<dd><p>Writes an error and ends the program</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<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>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.logging.logger_abc.LoggerABC.header">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">header</span></code><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="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.logging.logger_abc.LoggerABC.header" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Writes a header message
|
||||
:param string:
|
||||
:return:</p>
|
||||
<dd><p>Writes a header message</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 write as header</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.logging.logger_abc.LoggerABC.info">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.logging.logger_abc.LoggerABC.info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Writes an information
|
||||
:param name:
|
||||
:param message:
|
||||
:return:</p>
|
||||
<dd><p>Writes an information</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<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>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.logging.logger_abc.LoggerABC.trace">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">trace</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.logging.logger_abc.LoggerABC.trace" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Writes a trace message
|
||||
:param name:
|
||||
:param message:
|
||||
:return:</p>
|
||||
<dd><p>Writes a trace message</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<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>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.logging.logger_abc.LoggerABC.warn">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">warn</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.logging.logger_abc.LoggerABC.warn" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Writes an warning
|
||||
:param name:
|
||||
:param message:
|
||||
:return:</p>
|
||||
<dd><p>Writes an warning</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<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>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -255,75 +292,121 @@
|
|||
<dt id="cpl.logging.logger_service.Logger">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.logging.logger_service.</span></code><code class="sig-name descname"><span class="pre">Logger</span></code><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="n"><a class="reference internal" href="#cpl.logging.logging_settings.LoggingSettings" title="cpl.logging.logging_settings.LoggingSettings"><span class="pre">cpl.logging.logging_settings.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="n"><a class="reference internal" href="cpl.time.html#cpl.time.time_format_settings.TimeFormatSettings" title="cpl.time.time_format_settings.TimeFormatSettings"><span class="pre">cpl.time.time_format_settings.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="n"><a class="reference internal" href="cpl.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.logging.logger_service.Logger" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.logging.logger_abc.LoggerABC" title="cpl.logging.logger_abc.LoggerABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.logging.logger_abc.LoggerABC</span></code></a></p>
|
||||
<p>Service for logging</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>logging_settings: <a class="reference internal" href="#cpl.logging.logging_settings.LoggingSettings" title="cpl.logging.logging_settings.LoggingSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.logging.logging_settings.LoggingSettings</span></code></a></dt><dd><p>Settings for the logger</p>
|
||||
</dd>
|
||||
<dt>time_format: <a class="reference internal" href="cpl.time.html#cpl.time.time_format_settings.TimeFormatSettings" title="cpl.time.time_format_settings.TimeFormatSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.time.time_format_settings.TimeFormatSettings</span></code></a></dt><dd><p>Time format settings</p>
|
||||
</dd>
|
||||
<dt>env: <a class="reference internal" href="cpl.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></code></a></dt><dd><p>Environment of the application</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<dl class="py method">
|
||||
<dt id="cpl.logging.logger_service.Logger.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <span class="pre">None</span><a class="headerlink" href="#cpl.logging.logger_service.Logger.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates path tree and logfile
|
||||
:return:</p>
|
||||
<dd><p>Creates path tree and logfile</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.logging.logger_service.Logger.debug">
|
||||
<code class="sig-name descname"><span class="pre">debug</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.logging.logger_service.Logger.debug" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Writes a debug message
|
||||
:param name:
|
||||
:param message:
|
||||
:return:</p>
|
||||
<dd><p>Writes a debug message</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<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>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.logging.logger_service.Logger.error">
|
||||
<code class="sig-name descname"><span class="pre">error</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Exception</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.logging.logger_service.Logger.error" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Writes an error
|
||||
:param name:
|
||||
:param message:
|
||||
:param ex:
|
||||
:return:</p>
|
||||
<dd><p>Writes an error</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<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>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.logging.logger_service.Logger.fatal">
|
||||
<code class="sig-name descname"><span class="pre">fatal</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ex</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Exception</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.logging.logger_service.Logger.fatal" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Writes an error and exits
|
||||
:param name:
|
||||
:param message:
|
||||
:param ex:
|
||||
:return:</p>
|
||||
<dd><p>Writes an error and ends the program</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<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>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.logging.logger_service.Logger.header">
|
||||
<code class="sig-name descname"><span class="pre">header</span></code><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="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.logging.logger_service.Logger.header" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Writes a header message
|
||||
:param string:
|
||||
:return:</p>
|
||||
<dd><p>Writes a header message</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 write as header</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.logging.logger_service.Logger.info">
|
||||
<code class="sig-name descname"><span class="pre">info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.logging.logger_service.Logger.info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Writes an information
|
||||
:param name:
|
||||
:param message:
|
||||
:return:</p>
|
||||
<dd><p>Writes an information</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<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>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.logging.logger_service.Logger.trace">
|
||||
<code class="sig-name descname"><span class="pre">trace</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.logging.logger_service.Logger.trace" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Writes a trace message
|
||||
:param name:
|
||||
:param message:
|
||||
:return:</p>
|
||||
<dd><p>Writes a trace message</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<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>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.logging.logger_service.Logger.warn">
|
||||
<code class="sig-name descname"><span class="pre">warn</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.logging.logger_service.Logger.warn" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Writes an warning
|
||||
:param name:
|
||||
:param message:
|
||||
:return:</p>
|
||||
<dd><p>Writes an warning</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<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>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -380,6 +463,7 @@
|
|||
<dt id="cpl.logging.logging_settings.LoggingSettings">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.logging.logging_settings.</span></code><code class="sig-name descname"><span class="pre">LoggingSettings</span></code><a class="headerlink" href="#cpl.logging.logging_settings.LoggingSettings" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a></p>
|
||||
<p>Representation of logging settings</p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl.logging.logging_settings.LoggingSettings.console">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">console</span></code><a class="headerlink" href="#cpl.logging.logging_settings.LoggingSettings.console" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
|
|||
106
docs/build/html/cpl.mailing.html
vendored
106
docs/build/html/cpl.mailing.html
vendored
|
|
@ -182,20 +182,43 @@
|
|||
<dt id="cpl.mailing.email.EMail">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.mailing.email.</span></code><code class="sig-name descname"><span class="pre">EMail</span></code><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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transceiver</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">receiver</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email.EMail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>Represents an email</p>
|
||||
<blockquote>
|
||||
<div><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 E-Mail</p>
|
||||
</dd>
|
||||
<dt>subject: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Subject of the E-Mail</p>
|
||||
</dd>
|
||||
<dt>body: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Body of the E-Mail</p>
|
||||
</dd>
|
||||
<dt>transceiver: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Transceiver of the E-Mail</p>
|
||||
</dd>
|
||||
<dt>receiver: list[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</dt><dd><p>Receiver of the E-Mail</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<dl class="py method">
|
||||
<dt id="cpl.mailing.email.EMail.add_header">
|
||||
<code class="sig-name descname"><span class="pre">add_header</span></code><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="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email.EMail.add_header" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds header
|
||||
:param header:
|
||||
:return:</p>
|
||||
<dd><p>Adds header</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>header: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>The header of the E-Mail</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.mailing.email.EMail.add_receiver">
|
||||
<code class="sig-name descname"><span class="pre">add_receiver</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">receiver</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email.EMail.add_receiver" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds receiver
|
||||
:param receiver:
|
||||
:return:</p>
|
||||
<dd><p>Adds receiver</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>receiver: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>The receiver of the E-Mail</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
@ -206,17 +229,31 @@
|
|||
<dl class="py method">
|
||||
<dt id="cpl.mailing.email.EMail.check_mail">
|
||||
<em class="property"><span class="pre">static</span> </em><code class="sig-name descname"><span class="pre">check_mail</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> → <span class="pre">bool</span><a class="headerlink" href="#cpl.mailing.email.EMail.check_mail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Checks if an email is valid
|
||||
:param address:
|
||||
:return:</p>
|
||||
<dd><p>Checks if an email is valid</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>address: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>The address to check</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<blockquote>
|
||||
<div><p>Result if E-Mail is valid or not</p>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.mailing.email.EMail.get_content">
|
||||
<code class="sig-name descname"><span class="pre">get_content</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">transceiver</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email.EMail.get_content" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the mail as string
|
||||
:param transceiver:
|
||||
:return:</p>
|
||||
<dd><p>Returns the mail as string</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>transceiver: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>The transceiver of the E-Mail</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<blockquote>
|
||||
<div><p>E-Mail as string</p>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
@ -258,19 +295,23 @@
|
|||
<dt id="cpl.mailing.email_client_abc.EMailClientABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.mailing.email_client_abc.</span></code><code class="sig-name descname"><span class="pre">EMailClientABC</span></code><a class="headerlink" href="#cpl.mailing.email_client_abc.EMailClientABC" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
|
||||
<p>ABC of <a class="reference internal" href="#cpl.mailing.email_client_service.EMailClient" title="cpl.mailing.email_client_service.EMailClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.mailing.email_client_service.EMailClient</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl.mailing.email_client_abc.EMailClientABC.connect">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">connect</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email_client_abc.EMailClientABC.connect" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Connects to server
|
||||
:return:</p>
|
||||
<dd><p>Connects to server</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.mailing.email_client_abc.EMailClientABC.send_mail">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">send_mail</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">email</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl.mailing.email.EMail" title="cpl.mailing.email.EMail"><span class="pre">cpl.mailing.email.EMail</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email_client_abc.EMailClientABC.send_mail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sends email
|
||||
:param email:
|
||||
:return:</p>
|
||||
<dd><p>Sends email</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>email: <a class="reference internal" href="#cpl.mailing.email.EMail" title="cpl.mailing.email.EMail"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.mailing.email.EMail</span></code></a></dt><dd><p>Object of the E-Mail to send</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -282,33 +323,45 @@
|
|||
<dt id="cpl.mailing.email_client_service.EMailClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.mailing.email_client_service.</span></code><code class="sig-name descname"><span class="pre">EMailClient</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">environment</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">logger</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.logging.html#cpl.logging.logger_abc.LoggerABC" title="cpl.logging.logger_abc.LoggerABC"><span class="pre">cpl.logging.logger_abc.LoggerABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">mail_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl.mailing.email_client_settings.EMailClientSettings" title="cpl.mailing.email_client_settings.EMailClientSettings"><span class="pre">cpl.mailing.email_client_settings.EMailClientSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email_client_service.EMailClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.mailing.email_client_abc.EMailClientABC" title="cpl.mailing.email_client_abc.EMailClientABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.mailing.email_client_abc.EMailClientABC</span></code></a></p>
|
||||
<p>Service to send emails</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>environment: <a class="reference internal" href="cpl.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></code></a></dt><dd><p>Environment of the application</p>
|
||||
</dd>
|
||||
<dt>logger: <a class="reference internal" href="cpl.logging.html#cpl.logging.logger_abc.LoggerABC" title="cpl.logging.logger_abc.LoggerABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.logging.logger_abc.LoggerABC</span></code></a></dt><dd><p>The logger to use</p>
|
||||
</dd>
|
||||
<dt>mail_settings: <a class="reference internal" href="#cpl.mailing.email_client_settings.EMailClientSettings" title="cpl.mailing.email_client_settings.EMailClientSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.mailing.email_client_settings.EMailClientSettings</span></code></a></dt><dd><p>Settings for mailing</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<dl class="py method">
|
||||
<dt id="cpl.mailing.email_client_service.EMailClient.connect">
|
||||
<code class="sig-name descname"><span class="pre">connect</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email_client_service.EMailClient.connect" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Connects to server
|
||||
:return:</p>
|
||||
<dd><p>Connects to server</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.mailing.email_client_service.EMailClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email_client_service.EMailClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates connection
|
||||
:return:</p>
|
||||
<dd><p>Creates connection</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.mailing.email_client_service.EMailClient.login">
|
||||
<code class="sig-name descname"><span class="pre">login</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email_client_service.EMailClient.login" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Login to server
|
||||
:return:</p>
|
||||
<dd><p>Login to server</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl.mailing.email_client_service.EMailClient.send_mail">
|
||||
<code class="sig-name descname"><span class="pre">send_mail</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">email</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl.mailing.email.EMail" title="cpl.mailing.email.EMail"><span class="pre">cpl.mailing.email.EMail</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.mailing.email_client_service.EMailClient.send_mail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sends email
|
||||
:param email:
|
||||
:return:</p>
|
||||
<dd><p>Sends email</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>email: <a class="reference internal" href="#cpl.mailing.email.EMail" title="cpl.mailing.email.EMail"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.mailing.email.EMail</span></code></a></dt><dd><p>Object of the E-Mail to send</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -320,6 +373,7 @@
|
|||
<dt id="cpl.mailing.email_client_settings.EMailClientSettings">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.mailing.email_client_settings.</span></code><code class="sig-name descname"><span class="pre">EMailClientSettings</span></code><a class="headerlink" href="#cpl.mailing.email_client_settings.EMailClientSettings" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a></p>
|
||||
<p>Representation of mailing settings</p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl.mailing.email_client_settings.EMailClientSettings.credentials">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">credentials</span></code><a class="headerlink" href="#cpl.mailing.email_client_settings.EMailClientSettings.credentials" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
|
|||
1
docs/build/html/cpl.time.html
vendored
1
docs/build/html/cpl.time.html
vendored
|
|
@ -179,6 +179,7 @@
|
|||
<dt id="cpl.time.time_format_settings.TimeFormatSettings">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.time.time_format_settings.</span></code><code class="sig-name descname"><span class="pre">TimeFormatSettings</span></code><a class="headerlink" href="#cpl.time.time_format_settings.TimeFormatSettings" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="cpl.configuration.html#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a></p>
|
||||
<p>Representation of time format settings</p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl.time.time_format_settings.TimeFormatSettings.date_format">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">date_format</span></code><a class="headerlink" href="#cpl.time.time_format_settings.TimeFormatSettings.date_format" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
|
|||
2
docs/build/html/searchindex.js
vendored
2
docs/build/html/searchindex.js
vendored
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue
Block a user