Added cpl-mail
This commit is contained in:
416
docs/build/html/cpl_core.dependency_injection.html
vendored
416
docs/build/html/cpl_core.dependency_injection.html
vendored
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_core.dependency_injection package — Common Python Library documentation</title>
|
||||
<title>cpl.core.dependency_injection package — Common Python Library documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -19,8 +19,8 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="cpl_core.environment package" href="cpl_core.environment.html" />
|
||||
<link rel="prev" title="cpl_core.database.context package" href="cpl_core.database.context.html" />
|
||||
<link rel="next" title="cpl.core.environment package" href="cpl.core.environment.html" />
|
||||
<link rel="prev" title="cpl.core.database.context package" href="cpl.core.database.context.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -48,66 +48,66 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
|
||||
<li class="toctree-l2"><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 current"><a class="current reference internal" href="#">cpl_core.dependency_injection package</a><ul>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl.core.html">API reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.application.html">cpl.core.application package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.configuration.html">cpl.core.configuration package</a></li>
|
||||
<li class="toctree-l2"><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 current"><a class="current reference internal" href="#">cpl.core.dependency_injection package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.scope">cpl_core.dependency_injection.scope module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.scope.Scope"><code class="docutils literal notranslate"><span class="pre">Scope</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection.scope">cpl.core.dependency_injection.scope module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.scope.Scope"><code class="docutils literal notranslate"><span class="pre">Scope</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.scope_abc">cpl_core.dependency_injection.scope_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="docutils literal notranslate"><span class="pre">ScopeABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection.scope_abc">cpl.core.dependency_injection.scope_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC"><code class="docutils literal notranslate"><span class="pre">ScopeABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.scope_builder">cpl_core.dependency_injection.scope_builder module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.scope_builder.ScopeBuilder"><code class="docutils literal notranslate"><span class="pre">ScopeBuilder</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection.scope_builder">cpl.core.dependency_injection.scope_builder module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.scope_builder.ScopeBuilder"><code class="docutils literal notranslate"><span class="pre">ScopeBuilder</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_collection">cpl_core.dependency_injection.service_collection module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection.ServiceCollection"><code class="docutils literal notranslate"><span class="pre">ServiceCollection</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection.service_collection">cpl.core.dependency_injection.service_collection module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.service_collection.ServiceCollection"><code class="docutils literal notranslate"><span class="pre">ServiceCollection</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_collection_abc">cpl_core.dependency_injection.service_collection_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="docutils literal notranslate"><span class="pre">ServiceCollectionABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection.service_collection_abc">cpl.core.dependency_injection.service_collection_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="docutils literal notranslate"><span class="pre">ServiceCollectionABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_descriptor">cpl_core.dependency_injection.service_descriptor module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor"><code class="docutils literal notranslate"><span class="pre">ServiceDescriptor</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection.service_descriptor">cpl.core.dependency_injection.service_descriptor module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.service_descriptor.ServiceDescriptor"><code class="docutils literal notranslate"><span class="pre">ServiceDescriptor</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_lifetime_enum">cpl_core.dependency_injection.service_lifetime_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><code class="docutils literal notranslate"><span class="pre">ServiceLifetimeEnum</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection.service_lifetime_enum">cpl.core.dependency_injection.service_lifetime_enum module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><code class="docutils literal notranslate"><span class="pre">ServiceLifetimeEnum</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_provider">cpl_core.dependency_injection.service_provider module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider.ServiceProvider"><code class="docutils literal notranslate"><span class="pre">ServiceProvider</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection.service_provider">cpl.core.dependency_injection.service_provider module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.service_provider.ServiceProvider"><code class="docutils literal notranslate"><span class="pre">ServiceProvider</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection.service_provider_abc">cpl_core.dependency_injection.service_provider_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="docutils literal notranslate"><span class="pre">ServiceProviderABC</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection.service_provider_abc">cpl.core.dependency_injection.service_provider_abc module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="docutils literal notranslate"><span class="pre">ServiceProviderABC</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.dependency_injection">Module contents</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.core.dependency_injection">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.dependency_injection.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl.core.dependency_injection.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.log.html">cpl_core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_mail.html">cpl_mail 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>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.environment.html">cpl.core.environment package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.core.log.html">cpl.core.log package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl.mail.html">cpl.mail 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">Discord Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl.query.html">Query reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -125,10 +125,10 @@
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl_core.dependency_injection package</li>
|
||||
<li class="breadcrumb-item"><a href="cpl.core.html">API reference</a></li>
|
||||
<li class="breadcrumb-item active">cpl.core.dependency_injection package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_core.dependency_injection.rst.txt" rel="nofollow"> View page source</a>
|
||||
<a href="_sources/cpl.core.dependency_injection.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
@@ -137,28 +137,28 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="cpl-core-dependency-injection-package">
|
||||
<h1>cpl_core.dependency_injection package<a class="headerlink" href="#cpl-core-dependency-injection-package" title="Permalink to this heading"></a></h1>
|
||||
<h1>cpl.core.dependency_injection package<a class="headerlink" href="#cpl-core-dependency-injection-package" title="Permalink to this heading"></a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection.scope">
|
||||
<span id="cpl-core-dependency-injection-scope-module"></span><h2>cpl_core.dependency_injection.scope module<a class="headerlink" href="#module-cpl_core.dependency_injection.scope" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection.scope">
|
||||
<span id="cpl-core-dependency-injection-scope-module"></span><h2>cpl.core.dependency_injection.scope module<a class="headerlink" href="#module-cpl.core.dependency_injection.scope" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.scope.Scope">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.scope.</span></span><span class="sig-name descname"><span class="pre">Scope</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.scope.Scope" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScopeABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.scope.Scope">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.scope.</span></span><span class="sig-name descname"><span class="pre">Scope</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.scope.Scope" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScopeABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.scope.Scope.dispose">
|
||||
<span class="sig-name descname"><span class="pre">dispose</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.scope.Scope.dispose" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.scope.Scope.dispose">
|
||||
<span class="sig-name descname"><span class="pre">dispose</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.scope.Scope.dispose" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets service_provider to None</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.scope.Scope.service_provider">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">service_provider</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></em><a class="headerlink" href="#cpl_core.dependency_injection.scope.Scope.service_provider" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.scope.Scope.service_provider">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">service_provider</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></em><a class="headerlink" href="#cpl.core.dependency_injection.scope.Scope.service_provider" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns to service provider of scope</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -166,25 +166,25 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection.scope_abc">
|
||||
<span id="cpl-core-dependency-injection-scope-abc-module"></span><h2>cpl_core.dependency_injection.scope_abc module<a class="headerlink" href="#module-cpl_core.dependency_injection.scope_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection.scope_abc">
|
||||
<span id="cpl-core-dependency-injection-scope-abc-module"></span><h2>cpl.core.dependency_injection.scope_abc module<a class="headerlink" href="#module-cpl.core.dependency_injection.scope_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.scope_abc.ScopeABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.scope_abc.</span></span><span class="sig-name descname"><span class="pre">ScopeABC</span></span><a class="headerlink" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.scope_abc.ScopeABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.scope_abc.</span></span><span class="sig-name descname"><span class="pre">ScopeABC</span></span><a class="headerlink" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" 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>
|
||||
<p>ABC for the class <a class="reference internal" href="#cpl_core.dependency_injection.scope.Scope" title="cpl_core.dependency_injection.scope.Scope"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope.Scope</span></code></a></p>
|
||||
<p>ABC for the class <a class="reference internal" href="#cpl.core.dependency_injection.scope.Scope" title="cpl.core.dependency_injection.scope.Scope"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.scope.Scope</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.scope_abc.ScopeABC.dispose">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dispose</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.scope_abc.ScopeABC.dispose" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.scope_abc.ScopeABC.dispose">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dispose</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.scope_abc.ScopeABC.dispose" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets service_provider to None</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.scope_abc.ScopeABC.service_provider">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">service_provider</span></span><a class="headerlink" href="#cpl_core.dependency_injection.scope_abc.ScopeABC.service_provider" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.scope_abc.ScopeABC.service_provider">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">service_provider</span></span><a class="headerlink" href="#cpl.core.dependency_injection.scope_abc.ScopeABC.service_provider" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns to service provider of scope</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -192,19 +192,19 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection.scope_builder">
|
||||
<span id="cpl-core-dependency-injection-scope-builder-module"></span><h2>cpl_core.dependency_injection.scope_builder module<a class="headerlink" href="#module-cpl_core.dependency_injection.scope_builder" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection.scope_builder">
|
||||
<span id="cpl-core-dependency-injection-scope-builder-module"></span><h2>cpl.core.dependency_injection.scope_builder module<a class="headerlink" href="#module-cpl.core.dependency_injection.scope_builder" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.scope_builder.ScopeBuilder">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.scope_builder.</span></span><span class="sig-name descname"><span class="pre">ScopeBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.scope_builder.ScopeBuilder" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.scope_builder.ScopeBuilder">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.scope_builder.</span></span><span class="sig-name descname"><span class="pre">ScopeBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.scope_builder.ScopeBuilder" 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>Class to build <a class="reference internal" href="#cpl_core.dependency_injection.scope.Scope" title="cpl_core.dependency_injection.scope.Scope"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope.Scope</span></code></a></p>
|
||||
<p>Class to build <a class="reference internal" href="#cpl.core.dependency_injection.scope.Scope" title="cpl.core.dependency_injection.scope.Scope"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.scope.Scope</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.scope_builder.ScopeBuilder.build">
|
||||
<span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.scope_builder.ScopeBuilder.build" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.scope_builder.ScopeBuilder.build">
|
||||
<span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></span><a class="headerlink" href="#cpl.core.dependency_injection.scope_builder.ScopeBuilder.build" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns scope</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope.Scope" title="cpl_core.dependency_injection.scope.Scope"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope.Scope</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl.core.dependency_injection.scope.Scope" title="cpl.core.dependency_injection.scope.Scope"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.scope.Scope</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -212,20 +212,20 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection.service_collection">
|
||||
<span id="cpl-core-dependency-injection-service-collection-module"></span><h2>cpl_core.dependency_injection.service_collection module<a class="headerlink" href="#module-cpl_core.dependency_injection.service_collection" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection.service_collection">
|
||||
<span id="cpl-core-dependency-injection-service-collection-module"></span><h2>cpl.core.dependency_injection.service_collection module<a class="headerlink" href="#module-cpl.core.dependency_injection.service_collection" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_collection.</span></span><span class="sig-name descname"><span class="pre">ServiceCollection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceCollectionABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection.ServiceCollection">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.service_collection.</span></span><span class="sig-name descname"><span class="pre">ServiceCollection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_abc.ConfigurationABC" title="cpl.core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection.ServiceCollection" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceCollectionABC</span></code></a></p>
|
||||
<p>Representation of the collection of services</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_db_context">
|
||||
<span class="sig-name descname"><span class="pre">add_db_context</span></span><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="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_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.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_db_context" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection.ServiceCollection.add_db_context">
|
||||
<span class="sig-name descname"><span class="pre">add_db_context</span></span><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="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context_abc.DatabaseContextABC" title="cpl.core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_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.database.html#cpl.core.database.database_settings.DatabaseSettings" title="cpl.core.database.database_settings.DatabaseSettings"><span class="pre">DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection.ServiceCollection.add_db_context" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds database context</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>db_context: Type[<a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database context</p>
|
||||
<dt>db_context: Type[<a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context_abc.DatabaseContextABC" title="cpl.core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database context</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
@@ -233,20 +233,20 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_logging">
|
||||
<span class="sig-name descname"><span class="pre">add_logging</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_logging" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection.ServiceCollection.add_logging">
|
||||
<span class="sig-name descname"><span class="pre">add_logging</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection.ServiceCollection.add_logging" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds the CPL internal logger</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_pipes">
|
||||
<span class="sig-name descname"><span class="pre">add_pipes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_pipes" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection.ServiceCollection.add_pipes">
|
||||
<span class="sig-name descname"><span class="pre">add_pipes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection.ServiceCollection.add_pipes" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds the CPL internal pipes as transient</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_scoped">
|
||||
<span class="sig-name descname"><span class="pre">add_scoped</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_scoped" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection.ServiceCollection.add_scoped">
|
||||
<span class="sig-name descname"><span class="pre">add_scoped</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection.ServiceCollection.add_scoped" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with scoped lifetime</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -256,14 +256,14 @@
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_singleton">
|
||||
<span class="sig-name descname"><span class="pre">add_singleton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_singleton" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection.ServiceCollection.add_singleton">
|
||||
<span class="sig-name descname"><span class="pre">add_singleton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection.ServiceCollection.add_singleton" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with singleton lifetime</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -273,14 +273,14 @@
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.add_transient">
|
||||
<span class="sig-name descname"><span class="pre">add_transient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.add_transient" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection.ServiceCollection.add_transient">
|
||||
<span class="sig-name descname"><span class="pre">add_transient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection.ServiceCollection.add_transient" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with transient lifetime</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -290,17 +290,17 @@
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection.ServiceCollection.build_service_provider">
|
||||
<span class="sig-name descname"><span class="pre">build_service_provider</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection.ServiceCollection.build_service_provider" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection.ServiceCollection.build_service_provider">
|
||||
<span class="sig-name descname"><span class="pre">build_service_provider</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection.ServiceCollection.build_service_provider" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates instance of the service provider</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -308,20 +308,20 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection.service_collection_abc">
|
||||
<span id="cpl-core-dependency-injection-service-collection-abc-module"></span><h2>cpl_core.dependency_injection.service_collection_abc module<a class="headerlink" href="#module-cpl_core.dependency_injection.service_collection_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection.service_collection_abc">
|
||||
<span id="cpl-core-dependency-injection-service-collection-abc-module"></span><h2>cpl.core.dependency_injection.service_collection_abc module<a class="headerlink" href="#module-cpl.core.dependency_injection.service_collection_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_collection_abc.</span></span><span class="sig-name descname"><span class="pre">ServiceCollectionABC</span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.service_collection_abc.</span></span><span class="sig-name descname"><span class="pre">ServiceCollectionABC</span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" 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>
|
||||
<p>ABC for the class <a class="reference internal" href="#cpl_core.dependency_injection.service_collection.ServiceCollection" title="cpl_core.dependency_injection.service_collection.ServiceCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection.ServiceCollection</span></code></a></p>
|
||||
<p>ABC for the class <a class="reference internal" href="#cpl.core.dependency_injection.service_collection.ServiceCollection" title="cpl.core.dependency_injection.service_collection.ServiceCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_collection.ServiceCollection</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_db_context">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_db_context</span></span><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="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_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.database.html#cpl_core.database.database_settings.DatabaseSettings" title="cpl_core.database.database_settings.DatabaseSettings"><span class="pre">DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_db_context" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_db_context">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_db_context</span></span><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="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context_abc.DatabaseContextABC" title="cpl.core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">DatabaseContextABC</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_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.database.html#cpl.core.database.database_settings.DatabaseSettings" title="cpl.core.database.database_settings.DatabaseSettings"><span class="pre">DatabaseSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_db_context" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds database context</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>db_context: Type[<a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database context</p>
|
||||
<dt>db_context: Type[<a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context_abc.DatabaseContextABC" title="cpl.core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database context</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
@@ -329,26 +329,26 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_discord">
|
||||
<span class="sig-name descname"><span class="pre">add_discord</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_discord" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_discord">
|
||||
<span class="sig-name descname"><span class="pre">add_discord</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_discord" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds the CPL discord</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_logging">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_logging</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_logging" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_logging">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_logging</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_logging" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds the CPL internal logger</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_pipes">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_pipes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_pipes" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_pipes">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_pipes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_pipes" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds the CPL internal pipes as transient</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_scoped</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_scoped</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_scoped" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with scoped lifetime</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -358,14 +358,14 @@
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_singleton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_singleton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_singleton" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with singleton lifetime</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -375,14 +375,14 @@
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_transient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_transient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_transient" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds a service with transient lifetime</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
@@ -392,23 +392,23 @@
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>self: <a class="reference internal" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_translation">
|
||||
<span class="sig-name descname"><span class="pre">add_translation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_translation" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_translation">
|
||||
<span class="sig-name descname"><span class="pre">add_translation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.add_translation" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds the CPL translation</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.build_service_provider">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_service_provider</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC.build_service_provider" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.build_service_provider">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_service_provider</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_collection_abc.ServiceCollectionABC.build_service_provider" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates instance of the service provider</p>
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
<dt>Returns:</dt><dd><p>Object of type <a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -416,97 +416,97 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection.service_descriptor">
|
||||
<span id="cpl-core-dependency-injection-service-descriptor-module"></span><h2>cpl_core.dependency_injection.service_descriptor module<a class="headerlink" href="#module-cpl_core.dependency_injection.service_descriptor" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection.service_descriptor">
|
||||
<span id="cpl-core-dependency-injection-service-descriptor-module"></span><h2>cpl.core.dependency_injection.service_descriptor module<a class="headerlink" href="#module-cpl.core.dependency_injection.service_descriptor" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_descriptor.</span></span><span class="sig-name descname"><span class="pre">ServiceDescriptor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">implementation</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">object</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lifetime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><span class="pre">ServiceLifetimeEnum</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_descriptor.ServiceDescriptor">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.service_descriptor.</span></span><span class="sig-name descname"><span class="pre">ServiceDescriptor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">implementation</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">object</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lifetime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><span class="pre">ServiceLifetimeEnum</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_descriptor.ServiceDescriptor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>Descriptor of a service</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><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_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum</span></code></a></dt><dd><p>Lifetime of the service</p>
|
||||
<dt>lifetime: <a class="reference internal" href="#cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum</span></code></a></dt><dd><p>Lifetime of the service</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.base_type">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">base_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.base_type" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_descriptor.ServiceDescriptor.base_type">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">base_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span></em><a class="headerlink" href="#cpl.core.dependency_injection.service_descriptor.ServiceDescriptor.base_type" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.implementation">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">implementation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">object</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.implementation" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_descriptor.ServiceDescriptor.implementation">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">implementation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">object</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#cpl.core.dependency_injection.service_descriptor.ServiceDescriptor.implementation" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.lifetime">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lifetime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><span class="pre">ServiceLifetimeEnum</span></a></em><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.lifetime" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_descriptor.ServiceDescriptor.lifetime">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">lifetime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum"><span class="pre">ServiceLifetimeEnum</span></a></em><a class="headerlink" href="#cpl.core.dependency_injection.service_descriptor.ServiceDescriptor.lifetime" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.service_type">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">service_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span></em><a class="headerlink" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor.service_type" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_descriptor.ServiceDescriptor.service_type">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">service_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span></em><a class="headerlink" href="#cpl.core.dependency_injection.service_descriptor.ServiceDescriptor.service_type" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection.service_lifetime_enum">
|
||||
<span id="cpl-core-dependency-injection-service-lifetime-enum-module"></span><h2>cpl_core.dependency_injection.service_lifetime_enum module<a class="headerlink" href="#module-cpl_core.dependency_injection.service_lifetime_enum" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection.service_lifetime_enum">
|
||||
<span id="cpl-core-dependency-injection-service-lifetime-enum-module"></span><h2>cpl.core.dependency_injection.service_lifetime_enum module<a class="headerlink" href="#module-cpl.core.dependency_injection.service_lifetime_enum" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_lifetime_enum.</span></span><span class="sig-name descname"><span class="pre">ServiceLifetimeEnum</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.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.service_lifetime_enum.</span></span><span class="sig-name descname"><span class="pre">ServiceLifetimeEnum</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.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
||||
<p>An enumeration.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.scoped">
|
||||
<span class="sig-name descname"><span class="pre">scoped</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.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.scoped" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.scoped">
|
||||
<span class="sig-name descname"><span class="pre">scoped</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.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.scoped" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.singleton">
|
||||
<span class="sig-name descname"><span class="pre">singleton</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.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.singleton" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.singleton">
|
||||
<span class="sig-name descname"><span class="pre">singleton</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.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.singleton" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.transient">
|
||||
<span class="sig-name descname"><span class="pre">transient</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.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.transient" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.transient">
|
||||
<span class="sig-name descname"><span class="pre">transient</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.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum.transient" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection.service_provider">
|
||||
<span id="cpl-core-dependency-injection-service-provider-module"></span><h2>cpl_core.dependency_injection.service_provider module<a class="headerlink" href="#module-cpl_core.dependency_injection.service_provider" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection.service_provider">
|
||||
<span id="cpl-core-dependency-injection-service-provider-module"></span><h2>cpl.core.dependency_injection.service_provider module<a class="headerlink" href="#module-cpl.core.dependency_injection.service_provider" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_provider.</span></span><span class="sig-name descname"><span class="pre">ServiceProvider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_descriptors</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor" title="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor"><span class="pre">cpl_core.dependency_injection.service_descriptor.ServiceDescriptor</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">DatabaseContextABC</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceProviderABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider.ServiceProvider">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.service_provider.</span></span><span class="sig-name descname"><span class="pre">ServiceProvider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_descriptors</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.core.dependency_injection.service_descriptor.ServiceDescriptor" title="cpl.core.dependency_injection.service_descriptor.ServiceDescriptor"><span class="pre">cpl.core.dependency_injection.service_descriptor.ServiceDescriptor</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_abc.ConfigurationABC" title="cpl.core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context_abc.DatabaseContextABC" title="cpl.core.database.context.database_context_abc.DatabaseContextABC"><span class="pre">DatabaseContextABC</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider.ServiceProvider" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceProviderABC</span></code></a></p>
|
||||
<p>Provider for the services</p>
|
||||
<section id="parameter">
|
||||
<h3>Parameter<a class="headerlink" href="#parameter" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>service_descriptors: list[<a class="reference internal" href="#cpl_core.dependency_injection.service_descriptor.ServiceDescriptor" title="cpl_core.dependency_injection.service_descriptor.ServiceDescriptor"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_descriptor.ServiceDescriptor</span></code></a>]</dt><dd><p>Descriptor of the service</p>
|
||||
<dt>service_descriptors: list[<a class="reference internal" href="#cpl.core.dependency_injection.service_descriptor.ServiceDescriptor" title="cpl.core.dependency_injection.service_descriptor.ServiceDescriptor"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_descriptor.ServiceDescriptor</span></code></a>]</dt><dd><p>Descriptor of the service</p>
|
||||
</dd>
|
||||
<dt>config: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.configuration.configuration_abc.ConfigurationABC</span></code></a></dt><dd><p>CPL Configuration</p>
|
||||
<dt>config: <a class="reference internal" href="cpl.core.configuration.html#cpl.core.configuration.configuration_abc.ConfigurationABC" title="cpl.core.configuration.configuration_abc.ConfigurationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.configuration.configuration_abc.ConfigurationABC</span></code></a></dt><dd><p>CPL Configuration</p>
|
||||
</dd>
|
||||
<dt>db_context: Optional[<a class="reference internal" href="cpl_core.database.context.html#cpl_core.database.context.database_context_abc.DatabaseContextABC" title="cpl_core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database representation</p>
|
||||
<dt>db_context: Optional[<a class="reference internal" href="cpl.core.database.context.html#cpl.core.database.context.database_context_abc.DatabaseContextABC" title="cpl.core.database.context.database_context_abc.DatabaseContextABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.database.context.database_context_abc.DatabaseContextABC</span></code></a>]</dt><dd><p>Database representation</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.build_by_signature">
|
||||
<span class="sig-name descname"><span class="pre">build_by_signature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sig</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Signature</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.build_by_signature" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider.ServiceProvider.build_by_signature">
|
||||
<span class="sig-name descname"><span class="pre">build_by_signature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sig</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Signature</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider.ServiceProvider.build_by_signature" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.build_service">
|
||||
<span class="sig-name descname"><span class="pre">build_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.build_service" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider.ServiceProvider.build_service">
|
||||
<span class="sig-name descname"><span class="pre">build_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider.ServiceProvider.build_service" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates instance of given type</p>
|
||||
<section id="id1">
|
||||
<h4>Parameter<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h4>
|
||||
@@ -526,26 +526,26 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.create_scope">
|
||||
<span class="sig-name descname"><span class="pre">create_scope</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.create_scope" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider.ServiceProvider.create_scope">
|
||||
<span class="sig-name descname"><span class="pre">create_scope</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider.ServiceProvider.create_scope" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates a service scope</p>
|
||||
<section id="id2">
|
||||
<h4>Returns<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></p>
|
||||
<div><p>Object of type <a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.scope_abc.ScopeABC</span></code></a></p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.get_service">
|
||||
<span class="sig-name descname"><span class="pre">get_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.get_service" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider.ServiceProvider.get_service">
|
||||
<span class="sig-name descname"><span class="pre">get_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider.ServiceProvider.get_service" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns instance of given type</p>
|
||||
<section id="id3">
|
||||
<h4>Parameter<a class="headerlink" href="#id3" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -553,20 +553,20 @@
|
||||
<section id="id4">
|
||||
<h4>Returns<a class="headerlink" href="#id4" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><p>Object of type Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
|
||||
<div><p>Object of type Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.type.T</span></code>]</p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.get_services">
|
||||
<span class="sig-name descname"><span class="pre">get_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.get_services" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider.ServiceProvider.get_services">
|
||||
<span class="sig-name descname"><span class="pre">get_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider.ServiceProvider.get_services" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns instance of given type</p>
|
||||
<section id="id5">
|
||||
<h4>Parameter<a class="headerlink" href="#id5" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -574,20 +574,20 @@
|
||||
<section id="id6">
|
||||
<h4>Returns<a class="headerlink" href="#id6" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><p>Object of type list[Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
|
||||
<div><p>Object of type list[Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.type.T</span></code>]</p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider.ServiceProvider.set_scope">
|
||||
<span class="sig-name descname"><span class="pre">set_scope</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider.ServiceProvider.set_scope" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider.ServiceProvider.set_scope">
|
||||
<span class="sig-name descname"><span class="pre">set_scope</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider.ServiceProvider.set_scope" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets the scope of service provider</p>
|
||||
<section id="id7">
|
||||
<h4>Parameter<a class="headerlink" href="#id7" title="Permalink to this heading"></a></h4>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></dt><dd><p>Service scope</p>
|
||||
<dt>Object of type <a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.scope_abc.ScopeABC</span></code></a></dt><dd><p>Service scope</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -598,21 +598,21 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection.service_provider_abc">
|
||||
<span id="cpl-core-dependency-injection-service-provider-abc-module"></span><h2>cpl_core.dependency_injection.service_provider_abc module<a class="headerlink" href="#module-cpl_core.dependency_injection.service_provider_abc" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection.service_provider_abc">
|
||||
<span id="cpl-core-dependency-injection-service-provider-abc-module"></span><h2>cpl.core.dependency_injection.service_provider_abc module<a class="headerlink" href="#module-cpl.core.dependency_injection.service_provider_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.service_provider_abc.</span></span><span class="sig-name descname"><span class="pre">ServiceProviderABC</span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.service_provider_abc.</span></span><span class="sig-name descname"><span class="pre">ServiceProviderABC</span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" 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>
|
||||
<p>ABC for the class <a class="reference internal" href="#cpl_core.dependency_injection.service_provider.ServiceProvider" title="cpl_core.dependency_injection.service_provider.ServiceProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.service_provider.ServiceProvider</span></code></a></p>
|
||||
<p>ABC for the class <a class="reference internal" href="#cpl.core.dependency_injection.service_provider.ServiceProvider" title="cpl.core.dependency_injection.service_provider.ServiceProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.service_provider.ServiceProvider</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_by_signature">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_by_signature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sig</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Signature</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_by_signature" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.build_by_signature">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_by_signature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sig</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Signature</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.build_by_signature" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_service">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.build_service" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.build_service">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">build_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.build_service" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates instance of given type</p>
|
||||
<section id="id8">
|
||||
<h3>Parameter<a class="headerlink" href="#id8" title="Permalink to this heading"></a></h3>
|
||||
@@ -632,26 +632,26 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.create_scope">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_scope</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.create_scope" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.create_scope">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_scope</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.create_scope" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Creates a service scope</p>
|
||||
<section id="id10">
|
||||
<h3>Returns<a class="headerlink" href="#id10" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><p>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></p>
|
||||
<div><p>Object of type <a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.scope_abc.ScopeABC</span></code></a></p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_service">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_service" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.get_service">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">T</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.get_service" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns instance of given type</p>
|
||||
<section id="id11">
|
||||
<h3>Parameter<a class="headerlink" href="#id11" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -659,20 +659,20 @@
|
||||
<section id="id12">
|
||||
<h3>Returns<a class="headerlink" href="#id12" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><p>Object of type Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
|
||||
<div><p>Object of type Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.type.T</span></code>]</p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_services">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.get_services" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.get_services">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">T</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.get_services" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns instance of given type</p>
|
||||
<section id="id13">
|
||||
<h3>Parameter<a class="headerlink" href="#id13" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
<dt>instance_type: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.type.T</span></code></dt><dd><p>The type of the searched instance</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -680,14 +680,14 @@
|
||||
<section id="id14">
|
||||
<h3>Returns<a class="headerlink" href="#id14" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><p>Object of type list[Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.type.T</span></code>]</p>
|
||||
<div><p>Object of type list[Optional[<code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.type.T</span></code>]</p>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.inject">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">inject</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.inject" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.inject">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">inject</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.inject" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Decorator to allow injection into static and class methods</p>
|
||||
<section id="id15">
|
||||
<h3>Parameter<a class="headerlink" href="#id15" title="Permalink to this heading"></a></h3>
|
||||
@@ -704,19 +704,19 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.set_global_provider">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_global_provider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.set_global_provider" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.set_global_provider">
|
||||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_global_provider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.set_global_provider" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.set_scope">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_scope</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC.set_scope" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.set_scope">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_scope</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><span class="pre">ScopeABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.service_provider_abc.ServiceProviderABC.set_scope" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sets the scope of service provider</p>
|
||||
<section id="id17">
|
||||
<h3>Parameter<a class="headerlink" href="#id17" title="Permalink to this heading"></a></h3>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>Object of type <a class="reference internal" href="#cpl_core.dependency_injection.scope_abc.ScopeABC" title="cpl_core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.dependency_injection.scope_abc.ScopeABC</span></code></a></dt><dd><p>Service scope</p>
|
||||
<dt>Object of type <a class="reference internal" href="#cpl.core.dependency_injection.scope_abc.ScopeABC" title="cpl.core.dependency_injection.scope_abc.ScopeABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.core.dependency_injection.scope_abc.ScopeABC</span></code></a></dt><dd><p>Service scope</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
@@ -726,8 +726,8 @@
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_core.dependency_injection">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_core.dependency_injection" title="Permalink to this heading"></a></h2>
|
||||
<section id="module-cpl.core.dependency_injection">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl.core.dependency_injection" 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>
|
||||
@@ -743,24 +743,24 @@
|
||||
</dl>
|
||||
</section>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_core.dependency_injection.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.dependency_injection.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.dependency_injection.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.core.dependency_injection.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.core.dependency_injection.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<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.dependency_injection.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_core.dependency_injection.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl.core.dependency_injection.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.dependency_injection.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_core.dependency_injection.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl.core.dependency_injection.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.dependency_injection.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_core.dependency_injection.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dt class="sig sig-object py" id="cpl.core.dependency_injection.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl.core.dependency_injection.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
@@ -773,8 +773,8 @@
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_core.database.context.html" class="btn btn-neutral float-left" title="cpl_core.database.context package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_core.environment.html" class="btn btn-neutral float-right" title="cpl_core.environment package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="cpl.core.database.context.html" class="btn btn-neutral float-left" title="cpl.core.database.context package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl.core.environment.html" class="btn btn-neutral float-right" title="cpl.core.environment package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
Reference in New Issue
Block a user