Overview
| Comment: | update Check |
|---|---|
| Downloads: | Tarball | ZIP archive | SQL archive |
| Timelines: | family | ancestors | descendants | both | trunk |
| Files: | files | file ages | folders |
| SHA3-256: |
2568a72ca8b8ca4985c295e7ab69ddc8 |
| User & Date: | mario on 2022-10-27 07:47:15 |
| Other Links: | manifest | tags |
Context
|
2022-10-27
| ||
| 07:58 | resurrect functions for doc check-in: f0163c8621 user: mario tags: trunk | |
| 07:47 | update Check check-in: 2568a72ca8 user: mario tags: trunk | |
| 07:44 | pylint fixes for pluginconf.depends check-in: 3be9f23c57 user: mario tags: trunk | |
Changes
Modified html/depends.html from [20c4a76bca] to [c59d901773].
| ︙ | ︙ | |||
29 30 31 32 33 34 35 | <section> </section> <section> </section> <section> <h2 class="section-title" id="header-classes">Classes</h2> <dl> | | | | 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<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>
<p># depends: config, appcore >= 2.0, bin:wkhtmltoimage, python < 3.5</p>
<p>Here only in-application modules are honored, system references
|
| ︙ | ︙ | |||
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 | <dt><strong><code>api</code></strong> : <code>list</code></dt> <dd>allowed api: identifiers for .valid() stream checks</dd> <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> <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> <dt><strong><code>core</code></strong> : <code>list</code></dt> <dd>name list of virtual plugins</dd> </dl></div> <h3>Class variables</h3> <dl> | > | | | > > > > | | | | | | | | | | | | | | | > > | > | > | | | | | | | | | > | | 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
<dt><strong><code>api</code></strong> : <code>list</code></dt>
<dd>allowed api: identifiers for .valid() stream checks</dd>
<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>
<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.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"></div>
</dd>
<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.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"><p>Compare nested structure of [[dep],[alt,alt]]</p></div>
</dd>
<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"><p>Single comparison</p></div>
</dd>
<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>Verify depends: and breaks: against existing plugins/modules</p></div>
</dd>
<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"><p>Probes "bin:name" or "python:name" dependency URNs</p></div>
</dd>
<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"><p>Breaks/Conflicts: check [[or],[or]]</p></div>
</dd>
<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"><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.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>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>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="pluginconf" href="index.html">pluginconf</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<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.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>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>
|