Index: html/depends.html ================================================================== --- html/depends.html +++ html/depends.html @@ -31,12 +31,12 @@ <section> </section> <section> <h2 class="section-title" id="header-classes">Classes</h2> <dl> -<dt id="pluginconf.depends.DependencyValidation"><code class="flex name class"> -<span>class <span class="ident">DependencyValidation</span></span> +<dt id="pluginconf.depends.Check"><code class="flex name class"> +<span>class <span class="ident">Check</span></span> <span>(</span><span>add={}, core=['st2', 'uikit', 'config', 'action'])</span> </code></dt> <dd> <div class="desc"><p>Now this definitely requires customization. Each plugin can carry a list of (soft-) dependency names.</p> @@ -57,10 +57,11 @@ <dt><strong><code>log</code></strong> : <code>logging</code></dt> <dd>warning handler</dd> <dt><strong><code>have</code></strong> : <code>dict</code></dt> <dd>accumulated list of existing/virtual plugins</dd> </dl> +<p>Prepare list of known plugins and versions in self.have={}</p> <h2 id="parameters">Parameters</h2> <dl> <dt><strong><code>add</code></strong> : <code>dict</code></dt> <dd>name to pmd list of existing/core/virtual plugins (can define versions or own dependencies)</dd> @@ -67,62 +68,70 @@ <dt><strong><code>core</code></strong> : <code>list</code></dt> <dd>name list of virtual plugins</dd> </dl></div> <h3>Class variables</h3> <dl> -<dt id="pluginconf.depends.DependencyValidation.api"><code class="name">var <span class="ident">api</span></code></dt> +<dt id="pluginconf.depends.Check.api"><code class="name">var <span class="ident">api</span></code></dt> +<dd> +<div class="desc"></div> +</dd> +<dt id="pluginconf.depends.Check.log"><code class="name">var <span class="ident">log</span></code></dt> <dd> -<div class="desc"><p>debugging</p></div> +<div class="desc"></div> </dd> -<dt id="pluginconf.depends.DependencyValidation.log"><code class="name">var <span class="ident">log</span></code></dt> +<dt id="pluginconf.depends.Check.system_deps"><code class="name">var <span class="ident">system_deps</span></code></dt> <dd> <div class="desc"></div> </dd> </dl> <h3>Methods</h3> <dl> -<dt id="pluginconf.depends.DependencyValidation.and_or"><code class="name flex"> -<span>def <span class="ident">and_or</span></span>(<span>self, deps, have, r=True)</span> +<dt id="pluginconf.depends.Check.and_or"><code class="name flex"> +<span>def <span class="ident">and_or</span></span>(<span>self, deps, have, inner_true=True)</span> </code></dt> <dd> -<div class="desc"></div> +<div class="desc"><p>Compare nested structure of [[dep],[alt,alt]]</p></div> </dd> -<dt id="pluginconf.depends.DependencyValidation.cmp"><code class="name flex"> -<span>def <span class="ident">cmp</span></span>(<span>self, d, have, absent=True)</span> +<dt id="pluginconf.depends.Check.cmp"><code class="name flex"> +<span>def <span class="ident">cmp</span></span>(<span>self, name_op_ver, have, absent=True)</span> </code></dt> <dd> -<div class="desc"></div> +<div class="desc"><p>Single comparison</p></div> </dd> -<dt id="pluginconf.depends.DependencyValidation.depends"><code class="name flex"> +<dt id="pluginconf.depends.Check.depends"><code class="name flex"> <span>def <span class="ident">depends</span></span>(<span>self, plugin)</span> </code></dt> <dd> -<div class="desc"><p>test depends: and breaks:</p></div> +<div class="desc"><p>Verify depends: and breaks: against existing plugins/modules</p></div> </dd> -<dt id="pluginconf.depends.DependencyValidation.module_test"><code class="name flex"> -<span>def <span class="ident">module_test</span></span>(<span>self, type, name)</span> +<dt id="pluginconf.depends.Check.module_test"><code class="name flex"> +<span>def <span class="ident">module_test</span></span>(<span>self, urn, name)</span> </code></dt> <dd> -<div class="desc"></div> +<div class="desc"><p>Probes "bin:name" or "python:name" dependency URNs</p></div> </dd> -<dt id="pluginconf.depends.DependencyValidation.neither"><code class="name flex"> +<dt id="pluginconf.depends.Check.neither"><code class="name flex"> <span>def <span class="ident">neither</span></span>(<span>self, deps, have)</span> </code></dt> <dd> -<div class="desc"></div> +<div class="desc"><p>Breaks/Conflicts: check [[or],[or]]</p></div> </dd> -<dt id="pluginconf.depends.DependencyValidation.split"><code class="name flex"> +<dt id="pluginconf.depends.Check.split"><code class="name flex"> <span>def <span class="ident">split</span></span>(<span>self, dep_str)</span> </code></dt> <dd> -<div class="desc"></div> +<div class="desc"><p>Split trivial "pkg | alt, mod>=1, uikit<4.0" string +into nested list [ [alt, alt], [dep], [dep] ]; +with each entry comprised of (name, operator, version).</p></div> </dd> -<dt id="pluginconf.depends.DependencyValidation.valid"><code class="name flex"> +<dt id="pluginconf.depends.Check.valid"><code class="name flex"> <span>def <span class="ident">valid</span></span>(<span>self, new_plugin)</span> </code></dt> <dd> -<div class="desc"><p>check plugin info from repository stream (fields there $name, $file, $dist, api, id, depends, etc)</p></div> +<div class="desc"><p>Plugin pre-screening from online repository stream. +Fields are $name, $file, $dist, api, id, depends, etc +Exclude installed or for newer-version presence.</p></div> </dd> </dl> </dd> </dl> </section> @@ -139,21 +148,22 @@ </ul> </li> <li><h3><a href="#header-classes">Classes</a></h3> <ul> <li> -<h4><code><a title="pluginconf.depends.DependencyValidation" href="#pluginconf.depends.DependencyValidation">DependencyValidation</a></code></h4> +<h4><code><a title="pluginconf.depends.Check" href="#pluginconf.depends.Check">Check</a></code></h4> <ul class="two-column"> -<li><code><a title="pluginconf.depends.DependencyValidation.and_or" href="#pluginconf.depends.DependencyValidation.and_or">and_or</a></code></li> -<li><code><a title="pluginconf.depends.DependencyValidation.api" href="#pluginconf.depends.DependencyValidation.api">api</a></code></li> -<li><code><a title="pluginconf.depends.DependencyValidation.cmp" href="#pluginconf.depends.DependencyValidation.cmp">cmp</a></code></li> -<li><code><a title="pluginconf.depends.DependencyValidation.depends" href="#pluginconf.depends.DependencyValidation.depends">depends</a></code></li> -<li><code><a title="pluginconf.depends.DependencyValidation.log" href="#pluginconf.depends.DependencyValidation.log">log</a></code></li> -<li><code><a title="pluginconf.depends.DependencyValidation.module_test" href="#pluginconf.depends.DependencyValidation.module_test">module_test</a></code></li> -<li><code><a title="pluginconf.depends.DependencyValidation.neither" href="#pluginconf.depends.DependencyValidation.neither">neither</a></code></li> -<li><code><a title="pluginconf.depends.DependencyValidation.split" href="#pluginconf.depends.DependencyValidation.split">split</a></code></li> -<li><code><a title="pluginconf.depends.DependencyValidation.valid" href="#pluginconf.depends.DependencyValidation.valid">valid</a></code></li> +<li><code><a title="pluginconf.depends.Check.and_or" href="#pluginconf.depends.Check.and_or">and_or</a></code></li> +<li><code><a title="pluginconf.depends.Check.api" href="#pluginconf.depends.Check.api">api</a></code></li> +<li><code><a title="pluginconf.depends.Check.cmp" href="#pluginconf.depends.Check.cmp">cmp</a></code></li> +<li><code><a title="pluginconf.depends.Check.depends" href="#pluginconf.depends.Check.depends">depends</a></code></li> +<li><code><a title="pluginconf.depends.Check.log" href="#pluginconf.depends.Check.log">log</a></code></li> +<li><code><a title="pluginconf.depends.Check.module_test" href="#pluginconf.depends.Check.module_test">module_test</a></code></li> +<li><code><a title="pluginconf.depends.Check.neither" href="#pluginconf.depends.Check.neither">neither</a></code></li> +<li><code><a title="pluginconf.depends.Check.split" href="#pluginconf.depends.Check.split">split</a></code></li> +<li><code><a title="pluginconf.depends.Check.system_deps" href="#pluginconf.depends.Check.system_deps">system_deps</a></code></li> +<li><code><a title="pluginconf.depends.Check.valid" href="#pluginconf.depends.Check.valid">valid</a></code></li> </ul> </li> </ul> </li> </ul>