deploy: c191ef8

epics-containers · Jun 18, 2024 · 7518c57 · 7518c57
1 parent 2585de9
commit 7518c57
Show file tree

Hide file tree

Showing 40 changed files with 115 additions and 100 deletions.
diff --git a/list-arg2dict-param/.buildinfo b/list-arg2dict-param/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 3cfc4b9147c35e082c7b516b4802a0bc
+config: 72017941e50ab348892a937f63d6cef9
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/list-arg2dict-param/.doctrees/developer/explanations/entities.doctree b/list-arg2dict-param/.doctrees/developer/explanations/entities.doctree
diff --git a/list-arg2dict-param/.doctrees/environment.pickle b/list-arg2dict-param/.doctrees/environment.pickle
diff --git a/list-arg2dict-param/.doctrees/user/reference/api.doctree b/list-arg2dict-param/.doctrees/user/reference/api.doctree
diff --git a/list-arg2dict-param/_modules/ibek/globals.html b/list-arg2dict-param/_modules/ibek/globals.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>ibek.globals &#8212; ibek 3.0.0b6.dev76+g2bd5cb3a documentation</title>
+    <title>ibek.globals &#8212; ibek 3.0.0b6.dev77+gc191ef85 documentation</title>
 
 
 
@@ -37,7 +37,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=3ee479438cf8b5e0d341" />
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=3ee479438cf8b5e0d341"></script>
 
-    <script src="../../_static/documentation_options.js?v=ddf4d978"></script>
+    <script src="../../_static/documentation_options.js?v=358ec9ff"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -524,12 +524,12 @@ <h1>Source code for ibek.globals</h1><div class="highlight"><pre>
 
     <span class="nd">@property</span>
     <span class="k">def</span> <span class="nf">IBEK_DEFS</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;Directory containing ibek support yaml definitions.&quot;&quot;&quot;</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Directory containing ibek support yaml files.&quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_EPICS_ROOT</span> <span class="o">/</span> <span class="s2">&quot;ibek-defs&quot;</span>
 
     <span class="nd">@property</span>
     <span class="k">def</span> <span class="nf">PVI_DEFS</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;Directory containing pvi device yaml definitions.&quot;&quot;&quot;</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Directory containing pvi device yaml files.&quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_EPICS_ROOT</span> <span class="o">/</span> <span class="s2">&quot;pvi-defs&quot;</span>
 
     <span class="nd">@property</span>

diff --git a/list-arg2dict-param/_modules/ibek/ioc.html b/list-arg2dict-param/_modules/ibek/ioc.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>ibek.ioc &#8212; ibek 3.0.0b6.dev76+g2bd5cb3a documentation</title>
+    <title>ibek.ioc &#8212; ibek 3.0.0b6.dev77+gc191ef85 documentation</title>
 
 
 
@@ -37,7 +37,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=3ee479438cf8b5e0d341" />
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=3ee479438cf8b5e0d341"></script>
 
-    <script src="../../_static/documentation_options.js?v=ddf4d978"></script>
+    <script src="../../_static/documentation_options.js?v=358ec9ff"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -454,8 +454,8 @@
 
   <h1>Source code for ibek.ioc</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">Classes for generating an IocInstance derived class from a</span>
-<span class="sd">support module definition YAML file</span>
+<span class="sd">Classes for generating an IocInstance derived class from a set of</span>
+<span class="sd">support module YAML files</span>
 <span class="sd">&quot;&quot;&quot;</span>
 
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
@@ -518,7 +518,7 @@ <h1>Source code for ibek.ioc</h1><div class="highlight"><pre>
     <span class="n">entity_enabled</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
         <span class="n">description</span><span class="o">=</span><span class="s2">&quot;enable or disable this entity instance&quot;</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">True</span>
     <span class="p">)</span>
-    <span class="n">__definition__</span><span class="p">:</span> <span class="n">EntityModel</span>
+    <span class="n">_model</span><span class="p">:</span> <span class="n">EntityModel</span>
 
     <span class="k">def</span> <span class="nf">_process_field</span><span class="p">(</span><span class="bp">self</span><span class="p">:</span> <span class="n">Entity</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="n">typ</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
@@ -572,24 +572,24 @@ <h1>Source code for ibek.ioc</h1><div class="highlight"><pre>
 <span class="sd">        ibek.runtime_cmds.generate().</span>
 <span class="sd">        &quot;&quot;&quot;</span>
 
-        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">__definition__</span><span class="o">.</span><span class="n">pre_defines</span><span class="p">:</span>
-            <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">define</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">__definition__</span><span class="o">.</span><span class="n">pre_defines</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_model</span><span class="o">.</span><span class="n">pre_defines</span><span class="p">:</span>
+            <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">define</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_model</span><span class="o">.</span><span class="n">pre_defines</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
                 <span class="bp">self</span><span class="o">.</span><span class="n">_process_field</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">define</span><span class="o">.</span><span class="n">value</span><span class="p">,</span> <span class="n">define</span><span class="o">.</span><span class="n">type</span><span class="p">)</span>
 
-        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">__definition__</span><span class="o">.</span><span class="n">parameters</span><span class="p">:</span>
-            <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">parameter</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">__definition__</span><span class="o">.</span><span class="n">parameters</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_model</span><span class="o">.</span><span class="n">parameters</span><span class="p">:</span>
+            <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">parameter</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_model</span><span class="o">.</span><span class="n">parameters</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
                 <span class="bp">self</span><span class="o">.</span><span class="n">_process_field</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">),</span> <span class="n">parameter</span><span class="o">.</span><span class="n">type</span><span class="p">)</span>
 
-        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">__definition__</span><span class="o">.</span><span class="n">post_defines</span><span class="p">:</span>
-            <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">define</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">__definition__</span><span class="o">.</span><span class="n">post_defines</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_model</span><span class="o">.</span><span class="n">post_defines</span><span class="p">:</span>
+            <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">define</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_model</span><span class="o">.</span><span class="n">post_defines</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
                 <span class="bp">self</span><span class="o">.</span><span class="n">_process_field</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">define</span><span class="o">.</span><span class="n">value</span><span class="p">,</span> <span class="n">define</span><span class="o">.</span><span class="n">type</span><span class="p">)</span>
 
         <span class="k">return</span> <span class="bp">self</span></div>
 
 
     <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="c1"># if this entity has an id then its string representation is the value of id</span>
-        <span class="n">id_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__definition__</span><span class="o">.</span><span class="n">_get_id_arg</span><span class="p">()</span>
+        <span class="n">id_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_model</span><span class="o">.</span><span class="n">_get_id_arg</span><span class="p">()</span>
         <span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">id_name</span><span class="p">)</span> <span class="k">if</span> <span class="n">id_name</span> <span class="k">else</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__str__</span><span class="p">()</span>
 
     <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

diff --git a/list-arg2dict-param/_modules/ibek/render.html b/list-arg2dict-param/_modules/ibek/render.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>ibek.render &#8212; ibek 3.0.0b6.dev76+g2bd5cb3a documentation</title>
+    <title>ibek.render &#8212; ibek 3.0.0b6.dev77+gc191ef85 documentation</title>
 
 
 
@@ -37,7 +37,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=3ee479438cf8b5e0d341" />
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=3ee479438cf8b5e0d341"></script>
 
-    <script src="../../_static/documentation_options.js?v=ddf4d978"></script>
+    <script src="../../_static/documentation_options.js?v=358ec9ff"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -470,7 +470,7 @@ <h1>Source code for ibek.render</h1><div class="highlight"><pre>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    A class for generating snippets of startup script / EPICS DB</span>
 <span class="sd">    by using Jinja to combine snippet templates from support module</span>
-<span class="sd">    definition yaml with substitution values supplied in ioc entity yaml</span>
+<span class="sd">    yaml with substitution values supplied in ioc entity yaml</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">:</span> <span class="s2">&quot;Render&quot;</span><span class="p">):</span>
@@ -489,13 +489,13 @@ <h1>Source code for ibek.render</h1><div class="highlight"><pre>
 <span class="sd">        but we pass all strings though jinja again to render any other jinja</span>
 <span class="sd">        in the IOC (e.g. database and function entries)</span>
 
-<span class="sd">        once uses the name of the definition + suffix to track which lines</span>
+<span class="sd">        once uses the name of the model + suffix to track which lines</span>
 <span class="sd">        have been rendered already. The suffix can be used where a given</span>
 <span class="sd">        Entity has more than one element to render once (e.g. functions)</span>
 <span class="sd">        &quot;&quot;&quot;</span>
 
         <span class="k">if</span> <span class="n">when</span> <span class="o">==</span> <span class="n">When</span><span class="o">.</span><span class="n">first</span><span class="o">.</span><span class="n">value</span><span class="p">:</span>
-            <span class="n">name</span> <span class="o">=</span> <span class="n">instance</span><span class="o">.</span><span class="n">__definition__</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="n">suffix</span>
+            <span class="n">name</span> <span class="o">=</span> <span class="n">instance</span><span class="o">.</span><span class="n">_model</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="n">suffix</span>
             <span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">once_done</span><span class="p">:</span>
                 <span class="bp">self</span><span class="o">.</span><span class="n">once_done</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
             <span class="k">else</span><span class="p">:</span>
@@ -535,7 +535,7 @@ <h1>Source code for ibek.render</h1><div class="highlight"><pre>
 <span class="sd">        render the startup script by combining the jinja template from</span>
 <span class="sd">        an entity with the arguments from an Entity</span>
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="n">pre_init</span> <span class="o">=</span> <span class="n">instance</span><span class="o">.</span><span class="n">__definition__</span><span class="o">.</span><span class="n">pre_init</span>
+        <span class="n">pre_init</span> <span class="o">=</span> <span class="n">instance</span><span class="o">.</span><span class="n">_model</span><span class="o">.</span><span class="n">pre_init</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">render_script</span><span class="p">(</span><span class="n">instance</span><span class="p">,</span> <span class="n">pre_init</span><span class="p">)</span></div>
 
 
@@ -546,7 +546,7 @@ <h1>Source code for ibek.render</h1><div class="highlight"><pre>
 <span class="sd">        render the post-iocInit entries by combining the jinja template</span>
 <span class="sd">        from an entity with the arguments from an Entity</span>
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="n">post_init</span> <span class="o">=</span> <span class="n">instance</span><span class="o">.</span><span class="n">__definition__</span><span class="o">.</span><span class="n">post_init</span>
+        <span class="n">post_init</span> <span class="o">=</span> <span class="n">instance</span><span class="o">.</span><span class="n">_model</span><span class="o">.</span><span class="n">post_init</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">render_script</span><span class="p">(</span><span class="n">instance</span><span class="p">,</span> <span class="n">post_init</span><span class="p">)</span></div>
 
 
@@ -557,7 +557,7 @@ <h1>Source code for ibek.render</h1><div class="highlight"><pre>
 <span class="sd">        render the environment variable elements by combining the jinja template</span>
 <span class="sd">        from an entity with the arguments from an Entity</span>
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="n">variables</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">instance</span><span class="o">.</span><span class="n">__definition__</span><span class="p">,</span> <span class="s2">&quot;env_vars&quot;</span><span class="p">)</span>
+        <span class="n">variables</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">instance</span><span class="o">.</span><span class="n">_model</span><span class="p">,</span> <span class="s2">&quot;env_vars&quot;</span><span class="p">)</span>
         <span class="k">if</span> <span class="ow">not</span> <span class="n">variables</span><span class="p">:</span>
             <span class="k">return</span> <span class="kc">None</span>