182 lines
12 KiB
HTML
182 lines
12 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html class="writer-html5" lang="en" >
|
||
|
|
<head>
|
||
|
|
<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>Deprecated — Common Python Library documentation</title>
|
||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
|
|
<!--[if lt IE 9]>
|
||
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
||
|
|
<![endif]-->
|
||
|
|
|
||
|
|
<script src="_static/jquery.js"></script>
|
||
|
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||
|
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||
|
|
<script src="_static/doctools.js"></script>
|
||
|
|
<script src="_static/sphinx_highlight.js"></script>
|
||
|
|
<script src="_static/js/theme.js"></script>
|
||
|
|
<link rel="index" title="Index" href="genindex.html" />
|
||
|
|
<link rel="search" title="Search" href="search.html" />
|
||
|
|
<link rel="next" title="CLI reference" href="cpl_cli.html" />
|
||
|
|
<link rel="prev" title="Contributing to CPL" href="contributing.html" />
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body class="wy-body-for-nav">
|
||
|
|
<div class="wy-grid-for-nav">
|
||
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
|
|
<div class="wy-side-scroll">
|
||
|
|
<div class="wy-side-nav-search" >
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<a href="index.html" class="icon icon-home">
|
||
|
|
Common Python Library
|
||
|
|
</a>
|
||
|
|
<div role="search">
|
||
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
|
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
||
|
|
<input type="hidden" name="area" value="default" />
|
||
|
|
</form>
|
||
|
|
</div>
|
||
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
|
|
<ul class="current">
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">Deprecated</a><ul>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="#table-of-contents">Table of Contents</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="#configurationmodelabc-from-dict-method">ConfigurationModelABC from_dict method</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></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_translation.html">Translation reference</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
|
|
<a href="index.html">Common Python Library</a>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div class="wy-nav-content">
|
||
|
|
<div class="rst-content">
|
||
|
|
<div role="navigation" aria-label="Page navigation">
|
||
|
|
<ul class="wy-breadcrumbs">
|
||
|
|
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
|
|
<li class="breadcrumb-item active">Deprecated</li>
|
||
|
|
<li class="wy-breadcrumbs-aside">
|
||
|
|
<a href="_sources/deprecated.md.txt" rel="nofollow"> View page source</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<hr/>
|
||
|
|
</div>
|
||
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
|
|
<div itemprop="articleBody">
|
||
|
|
|
||
|
|
<section id="deprecated">
|
||
|
|
<h1>Deprecated<a class="headerlink" href="#deprecated" title="Permalink to this heading"></a></h1>
|
||
|
|
<section id="table-of-contents">
|
||
|
|
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this heading"></a></h2>
|
||
|
|
<ol class="arabic simple">
|
||
|
|
<li><p><a class="reference internal" href="#ConfigurationModelABC-from_dict-method"><span class="xref myst">ConfigurationModelABC.from_dict</span></a></p></li>
|
||
|
|
</ol>
|
||
|
|
</section>
|
||
|
|
<section id="configurationmodelabc-from-dict-method">
|
||
|
|
<h2>ConfigurationModelABC from_dict method<a class="headerlink" href="#configurationmodelabc-from-dict-method" title="Permalink to this heading"></a></h2>
|
||
|
|
<p>We now process the configuration models directly in the configuration by recursive parameter parsing.</p>
|
||
|
|
<p>The JSONProcessor now goes through the JSON and the arguments of the <strong>init</strong> and links the attributes by name from the
|
||
|
|
JSON and the name of the keyword argument.
|
||
|
|
Now, based on the type, either simply assigns the value. With a <code class="docutils literal notranslate"><span class="pre">dict</span></code> the processor is called recursively and so the
|
||
|
|
JSON is processed further. This way nested ConfigurationModels can be processed.</p>
|
||
|
|
<p>For this the code must be adapted as follows:</p>
|
||
|
|
<p>From this:</p>
|
||
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>class<span class="w"> </span>VersionSettings<span class="o">(</span>ConfigurationModelABC<span class="o">)</span>:
|
||
|
|
|
||
|
|
<span class="w"> </span>def<span class="w"> </span>__init__<span class="o">(</span>self<span class="o">)</span>:
|
||
|
|
<span class="w"> </span>ConfigurationModelABC.__init__<span class="o">(</span>self<span class="o">)</span>
|
||
|
|
|
||
|
|
<span class="w"> </span>self.major:<span class="w"> </span>Optional<span class="o">[</span>str<span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"0"</span>
|
||
|
|
<span class="w"> </span>self.minor:<span class="w"> </span>Optional<span class="o">[</span>str<span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"0"</span>
|
||
|
|
<span class="w"> </span>self.micro:<span class="w"> </span>Optional<span class="o">[</span>str<span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"0"</span>
|
||
|
|
|
||
|
|
<span class="w"> </span>def<span class="w"> </span>from_dict<span class="o">(</span>self,<span class="w"> </span>settings:<span class="w"> </span>dict<span class="o">)</span>:
|
||
|
|
<span class="w"> </span>self.major<span class="w"> </span><span class="o">=</span><span class="w"> </span>settings<span class="o">[</span><span class="s2">"Major"</span><span class="o">]</span>
|
||
|
|
<span class="w"> </span>self.minor<span class="w"> </span><span class="o">=</span><span class="w"> </span>settings<span class="o">[</span><span class="s2">"Minor"</span><span class="o">]</span>
|
||
|
|
<span class="w"> </span><span class="nv">micro</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>settings<span class="o">[</span><span class="s2">"Micro"</span><span class="o">]</span>
|
||
|
|
<span class="w"> </span><span class="k">if</span><span class="w"> </span>micro<span class="w"> </span>!<span class="o">=</span><span class="w"> </span><span class="s1">''</span>:
|
||
|
|
<span class="w"> </span>self.micro<span class="w"> </span><span class="o">=</span><span class="w"> </span>micro
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>To this:</p>
|
||
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>class<span class="w"> </span>VersionSettings<span class="o">(</span>ConfigurationModelABC<span class="o">)</span>:
|
||
|
|
<span class="w"> </span>def<span class="w"> </span>__init__<span class="o">(</span>self,<span class="w"> </span>major:<span class="w"> </span><span class="nv">str</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>None,<span class="w"> </span>minor:<span class="w"> </span><span class="nv">str</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>None,<span class="w"> </span>micro:<span class="w"> </span><span class="nv">str</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>None<span class="o">)</span>:
|
||
|
|
<span class="w"> </span>ConfigurationModelABC.__init__<span class="o">(</span>self<span class="o">)</span>
|
||
|
|
|
||
|
|
<span class="w"> </span>self.major:<span class="w"> </span>Optional<span class="o">[</span>str<span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>major
|
||
|
|
<span class="w"> </span>self.minor:<span class="w"> </span>Optional<span class="o">[</span>str<span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>minor
|
||
|
|
<span class="w"> </span>self.micro:<span class="w"> </span>Optional<span class="o">[</span>str<span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>micro<span class="w"> </span><span class="k">if</span><span class="w"> </span>micro<span class="w"> </span>!<span class="o">=</span><span class="w"> </span><span class="s2">""</span><span class="w"> </span><span class="k">else</span><span class="w"> </span>None
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>This makes the <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict"><span class="xref myst py py-meth">from_dict</span></a> function obsolete.</p>
|
||
|
|
<p>A few rules must be observed:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li><p>Only simple types can be processed
|
||
|
|
<br>
|
||
|
|
Wrong: <code class="docutils literal notranslate"><span class="pre">dict[str,</span> <span class="pre">str]</span></code>
|
||
|
|
<br>
|
||
|
|
Correct: <code class="docutils literal notranslate"><span class="pre">dict</span></code>
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
Incorrect: <code class="docutils literal notranslate"><span class="pre">list[str]</span></code>
|
||
|
|
<br>
|
||
|
|
Correct: <code class="docutils literal notranslate"><span class="pre">list</span></code></p></li>
|
||
|
|
<li><p>The arguments must be optional, i.e. created as kwargs
|
||
|
|
<br>
|
||
|
|
Incorrect: <code class="docutils literal notranslate"><span class="pre">def</span> <span class="pre">__init__(self,</span> <span class="pre">x:</span> <span class="pre">int,</span> <span class="pre">y:</span> <span class="pre">int)</span></code>
|
||
|
|
<br>
|
||
|
|
Correct: <code class="docutils literal notranslate"><span class="pre">def</span> <span class="pre">__init__(self,</span> <span class="pre">x:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">None,</span> <span class="pre">y:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">None)</span></code></p></li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
|
|
<a href="contributing.html" class="btn btn-neutral float-left" title="Contributing to CPL" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
|
|
<a href="cpl_cli.html" class="btn btn-neutral float-right" title="CLI reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<hr/>
|
||
|
|
|
||
|
|
<div role="contentinfo">
|
||
|
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
|
|
||
|
|
|
||
|
|
</footer>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</div>
|
||
|
|
<script>
|
||
|
|
jQuery(function () {
|
||
|
|
SphinxRtdTheme.Navigation.enable(true);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|