doc/build/html/commands/apidoc/src.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
   8     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   9     <title>src package &#8212; salomeTools 5.0.0dev documentation</title>
  10     <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
  11     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  12     <script type="text/javascript" src="../../_static/documentation_options.js"></script>
  13     <script type="text/javascript" src="../../_static/jquery.js"></script>
  14     <script type="text/javascript" src="../../_static/underscore.js"></script>
  15     <script type="text/javascript" src="../../_static/doctools.js"></script>
  16     <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
  17     <link rel="index" title="Index" href="../../genindex.html" />
  18     <link rel="search" title="Search" href="../../search.html" />
  19     <link rel="next" title="src.colorama package" href="src.colorama.html" />
  20     <link rel="prev" title="src" href="modules.html" />
  21
  22   <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  23
  24
  25   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  26
  27   </head><body>
  28
  29
  30     <div class="document">
  31       <div class="documentwrapper">
  32         <div class="bodywrapper">
  33           <div class="body" role="main">
  34
  35   <div class="section" id="src-package">
  36 <h1>src package<a class="headerlink" href="#src-package" title="Permalink to this headline">¶</a></h1>
  37 <div class="section" id="subpackages">
  38 <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
  39 <div class="toctree-wrapper compound">
  40 <ul>
  41 <li class="toctree-l1"><a class="reference internal" href="src.colorama.html">src.colorama package</a><ul>
  42 <li class="toctree-l2"><a class="reference internal" href="src.colorama.html#submodules">Submodules</a></li>
  43 <li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.ansi">src.colorama.ansi module</a></li>
  44 <li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.ansitowin32">src.colorama.ansitowin32 module</a></li>
  45 <li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.initialise">src.colorama.initialise module</a></li>
  46 <li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.win32">src.colorama.win32 module</a></li>
  47 <li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.winterm">src.colorama.winterm module</a></li>
  48 <li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama">Module contents</a></li>
  49 </ul>
  50 </li>
  51 </ul>
  52 </div>
  53 </div>
  54 <div class="section" id="submodules">
  55 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
  56 </div>
  57 <div class="section" id="module-src.ElementTree">
  58 <span id="src-elementtree-module"></span><h2>src.ElementTree module<a class="headerlink" href="#module-src.ElementTree" title="Permalink to this headline">¶</a></h2>
  59 <dl class="function">
  60 <dt id="src.ElementTree.Comment">
  61 <code class="descclassname">src.ElementTree.</code><code class="descname">Comment</code><span class="sig-paren">(</span><em>text=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#Comment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.Comment" title="Permalink to this definition">¶</a></dt>
  62 <dd></dd></dl>
  63
  64 <dl class="function">
  65 <dt id="src.ElementTree.dump">
  66 <code class="descclassname">src.ElementTree.</code><code class="descname">dump</code><span class="sig-paren">(</span><em>elem</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#dump"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.dump" title="Permalink to this definition">¶</a></dt>
  67 <dd></dd></dl>
  68
  69 <dl class="function">
  70 <dt id="src.ElementTree.Element">
  71 <code class="descclassname">src.ElementTree.</code><code class="descname">Element</code><span class="sig-paren">(</span><em>tag</em>, <em>attrib={}</em>, <em>**extra</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#Element"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.Element" title="Permalink to this definition">¶</a></dt>
  72 <dd></dd></dl>
  73
  74 <dl class="class">
  75 <dt id="src.ElementTree.ElementTree">
  76 <em class="property">class </em><code class="descclassname">src.ElementTree.</code><code class="descname">ElementTree</code><span class="sig-paren">(</span><em>element=None</em>, <em>file=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree" title="Permalink to this definition">¶</a></dt>
  77 <dd><dl class="method">
  78 <dt id="src.ElementTree.ElementTree.find">
  79 <code class="descname">find</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.find"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.find" title="Permalink to this definition">¶</a></dt>
  80 <dd></dd></dl>
  81
  82 <dl class="method">
  83 <dt id="src.ElementTree.ElementTree.findall">
  84 <code class="descname">findall</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.findall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.findall" title="Permalink to this definition">¶</a></dt>
  85 <dd></dd></dl>
  86
  87 <dl class="method">
  88 <dt id="src.ElementTree.ElementTree.findtext">
  89 <code class="descname">findtext</code><span class="sig-paren">(</span><em>path</em>, <em>default=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.findtext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.findtext" title="Permalink to this definition">¶</a></dt>
  90 <dd></dd></dl>
  91
  92 <dl class="method">
  93 <dt id="src.ElementTree.ElementTree.getiterator">
  94 <code class="descname">getiterator</code><span class="sig-paren">(</span><em>tag=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.getiterator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.getiterator" title="Permalink to this definition">¶</a></dt>
  95 <dd></dd></dl>
  96
  97 <dl class="method">
  98 <dt id="src.ElementTree.ElementTree.getroot">
  99 <code class="descname">getroot</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.getroot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.getroot" title="Permalink to this definition">¶</a></dt>
 100 <dd></dd></dl>
 101
 102 <dl class="method">
 103 <dt id="src.ElementTree.ElementTree.parse">
 104 <code class="descname">parse</code><span class="sig-paren">(</span><em>source</em>, <em>parser=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.parse" title="Permalink to this definition">¶</a></dt>
 105 <dd></dd></dl>
 106
 107 <dl class="method">
 108 <dt id="src.ElementTree.ElementTree.write">
 109 <code class="descname">write</code><span class="sig-paren">(</span><em>file</em>, <em>encoding='us-ascii'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ElementTree.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ElementTree.write" title="Permalink to this definition">¶</a></dt>
 110 <dd></dd></dl>
 111
 112 </dd></dl>
 113
 114 <dl class="function">
 115 <dt id="src.ElementTree.fromstring">
 116 <code class="descclassname">src.ElementTree.</code><code class="descname">fromstring</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="headerlink" href="#src.ElementTree.fromstring" title="Permalink to this definition">¶</a></dt>
 117 <dd></dd></dl>
 118
 119 <dl class="function">
 120 <dt id="src.ElementTree.iselement">
 121 <code class="descclassname">src.ElementTree.</code><code class="descname">iselement</code><span class="sig-paren">(</span><em>element</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#iselement"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.iselement" title="Permalink to this definition">¶</a></dt>
 122 <dd></dd></dl>
 123
 124 <dl class="class">
 125 <dt id="src.ElementTree.iterparse">
 126 <em class="property">class </em><code class="descclassname">src.ElementTree.</code><code class="descname">iterparse</code><span class="sig-paren">(</span><em>source</em>, <em>events=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#iterparse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.iterparse" title="Permalink to this definition">¶</a></dt>
 127 <dd><dl class="method">
 128 <dt id="src.ElementTree.iterparse.next">
 129 <code class="descname">next</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#iterparse.next"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.iterparse.next" title="Permalink to this definition">¶</a></dt>
 130 <dd></dd></dl>
 131
 132 </dd></dl>
 133
 134 <dl class="function">
 135 <dt id="src.ElementTree.parse">
 136 <code class="descclassname">src.ElementTree.</code><code class="descname">parse</code><span class="sig-paren">(</span><em>source</em>, <em>parser=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.parse" title="Permalink to this definition">¶</a></dt>
 137 <dd></dd></dl>
 138
 139 <dl class="function">
 140 <dt id="src.ElementTree.PI">
 141 <code class="descclassname">src.ElementTree.</code><code class="descname">PI</code><span class="sig-paren">(</span><em>target</em>, <em>text=None</em><span class="sig-paren">)</span><a class="headerlink" href="#src.ElementTree.PI" title="Permalink to this definition">¶</a></dt>
 142 <dd></dd></dl>
 143
 144 <dl class="function">
 145 <dt id="src.ElementTree.ProcessingInstruction">
 146 <code class="descclassname">src.ElementTree.</code><code class="descname">ProcessingInstruction</code><span class="sig-paren">(</span><em>target</em>, <em>text=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#ProcessingInstruction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.ProcessingInstruction" title="Permalink to this definition">¶</a></dt>
 147 <dd></dd></dl>
 148
 149 <dl class="class">
 150 <dt id="src.ElementTree.QName">
 151 <em class="property">class </em><code class="descclassname">src.ElementTree.</code><code class="descname">QName</code><span class="sig-paren">(</span><em>text_or_uri</em>, <em>tag=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#QName"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.QName" title="Permalink to this definition">¶</a></dt>
 152 <dd></dd></dl>
 153
 154 <dl class="function">
 155 <dt id="src.ElementTree.SubElement">
 156 <code class="descclassname">src.ElementTree.</code><code class="descname">SubElement</code><span class="sig-paren">(</span><em>parent</em>, <em>tag</em>, <em>attrib={}</em>, <em>**extra</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#SubElement"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.SubElement" title="Permalink to this definition">¶</a></dt>
 157 <dd></dd></dl>
 158
 159 <dl class="function">
 160 <dt id="src.ElementTree.tostring">
 161 <code class="descclassname">src.ElementTree.</code><code class="descname">tostring</code><span class="sig-paren">(</span><em>element</em>, <em>encoding=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#tostring"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.tostring" title="Permalink to this definition">¶</a></dt>
 162 <dd></dd></dl>
 163
 164 <dl class="class">
 165 <dt id="src.ElementTree.TreeBuilder">
 166 <em class="property">class </em><code class="descclassname">src.ElementTree.</code><code class="descname">TreeBuilder</code><span class="sig-paren">(</span><em>element_factory=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#TreeBuilder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.TreeBuilder" title="Permalink to this definition">¶</a></dt>
 167 <dd><dl class="method">
 168 <dt id="src.ElementTree.TreeBuilder.close">
 169 <code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#TreeBuilder.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.TreeBuilder.close" title="Permalink to this definition">¶</a></dt>
 170 <dd></dd></dl>
 171
 172 <dl class="method">
 173 <dt id="src.ElementTree.TreeBuilder.data">
 174 <code class="descname">data</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#TreeBuilder.data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.TreeBuilder.data" title="Permalink to this definition">¶</a></dt>
 175 <dd></dd></dl>
 176
 177 <dl class="method">
 178 <dt id="src.ElementTree.TreeBuilder.end">
 179 <code class="descname">end</code><span class="sig-paren">(</span><em>tag</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#TreeBuilder.end"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.TreeBuilder.end" title="Permalink to this definition">¶</a></dt>
 180 <dd></dd></dl>
 181
 182 <dl class="method">
 183 <dt id="src.ElementTree.TreeBuilder.start">
 184 <code class="descname">start</code><span class="sig-paren">(</span><em>tag</em>, <em>attrs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#TreeBuilder.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.TreeBuilder.start" title="Permalink to this definition">¶</a></dt>
 185 <dd></dd></dl>
 186
 187 </dd></dl>
 188
 189 <dl class="function">
 190 <dt id="src.ElementTree.XML">
 191 <code class="descclassname">src.ElementTree.</code><code class="descname">XML</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#XML"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.XML" title="Permalink to this definition">¶</a></dt>
 192 <dd></dd></dl>
 193
 194 <dl class="class">
 195 <dt id="src.ElementTree.XMLTreeBuilder">
 196 <em class="property">class </em><code class="descclassname">src.ElementTree.</code><code class="descname">XMLTreeBuilder</code><span class="sig-paren">(</span><em>html=0</em>, <em>target=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#XMLTreeBuilder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.XMLTreeBuilder" title="Permalink to this definition">¶</a></dt>
 197 <dd><dl class="method">
 198 <dt id="src.ElementTree.XMLTreeBuilder.close">
 199 <code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#XMLTreeBuilder.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.XMLTreeBuilder.close" title="Permalink to this definition">¶</a></dt>
 200 <dd></dd></dl>
 201
 202 <dl class="method">
 203 <dt id="src.ElementTree.XMLTreeBuilder.doctype">
 204 <code class="descname">doctype</code><span class="sig-paren">(</span><em>name</em>, <em>pubid</em>, <em>system</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#XMLTreeBuilder.doctype"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.XMLTreeBuilder.doctype" title="Permalink to this definition">¶</a></dt>
 205 <dd></dd></dl>
 206
 207 <dl class="method">
 208 <dt id="src.ElementTree.XMLTreeBuilder.feed">
 209 <code class="descname">feed</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/ElementTree.html#XMLTreeBuilder.feed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ElementTree.XMLTreeBuilder.feed" title="Permalink to this definition">¶</a></dt>
 210 <dd></dd></dl>
 211
 212 </dd></dl>
 213
 214 </div>
 215 <div class="section" id="module-src.architecture">
 216 <span id="src-architecture-module"></span><h2>src.architecture module<a class="headerlink" href="#module-src.architecture" title="Permalink to this headline">¶</a></h2>
 217 <p>In this file : all the stuff that can change with the architecture
 218 on which SAT is running</p>
 219 <dl class="function">
 220 <dt id="src.architecture.get_distrib_version">
 221 <code class="descclassname">src.architecture.</code><code class="descname">get_distrib_version</code><span class="sig-paren">(</span><em>distrib</em>, <em>codes</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/architecture.html#get_distrib_version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.architecture.get_distrib_version" title="Permalink to this definition">¶</a></dt>
 222 <dd><p>Gets the version of the distribution</p>
 223 <table class="docutils field-list" frame="void" rules="none">
 224 <col class="field-name" />
 225 <col class="field-body" />
 226 <tbody valign="top">
 227 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 228 <li><strong>str</strong> (<em>distrib</em>) – The distribution on which the version will be found.</li>
 229 <li><strong>L{Mapping}</strong> (<em>codes</em>) – The map containing distribution correlation table.</li>
 230 </ul>
 231 </td>
 232 </tr>
 233 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The version of the distribution on which salomeTools is running,
 234 regarding the distribution correlation table contained in codes
 235 variable.</p>
 236 </td>
 237 </tr>
 238 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
 239 </td>
 240 </tr>
 241 </tbody>
 242 </table>
 243 </dd></dl>
 244
 245 <dl class="function">
 246 <dt id="src.architecture.get_distribution">
 247 <code class="descclassname">src.architecture.</code><code class="descname">get_distribution</code><span class="sig-paren">(</span><em>codes</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/architecture.html#get_distribution"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.architecture.get_distribution" title="Permalink to this definition">¶</a></dt>
 248 <dd><p>Gets the code for the distribution</p>
 249 <table class="docutils field-list" frame="void" rules="none">
 250 <col class="field-name" />
 251 <col class="field-body" />
 252 <tbody valign="top">
 253 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>L{Mapping}</strong> (<em>codes</em>) – The map containing distribution correlation table.</td>
 254 </tr>
 255 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The distribution on which salomeTools is running, regarding the
 256 distribution correlation table contained in codes variable.</td>
 257 </tr>
 258 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
 259 </tr>
 260 </tbody>
 261 </table>
 262 </dd></dl>
 263
 264 <dl class="function">
 265 <dt id="src.architecture.get_nb_proc">
 266 <code class="descclassname">src.architecture.</code><code class="descname">get_nb_proc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/architecture.html#get_nb_proc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.architecture.get_nb_proc" title="Permalink to this definition">¶</a></dt>
 267 <dd><dl class="docutils">
 268 <dt>Gets the number of processors of the machine </dt>
 269 <dd>on which salomeTools is running.</dd>
 270 </dl>
 271 <table class="docutils field-list" frame="void" rules="none">
 272 <col class="field-name" />
 273 <col class="field-body" />
 274 <tbody valign="top">
 275 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the number of processors.</td>
 276 </tr>
 277 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>
 278 </tr>
 279 </tbody>
 280 </table>
 281 </dd></dl>
 282
 283 <dl class="function">
 284 <dt id="src.architecture.get_python_version">
 285 <code class="descclassname">src.architecture.</code><code class="descname">get_python_version</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/architecture.html#get_python_version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.architecture.get_python_version" title="Permalink to this definition">¶</a></dt>
 286 <dd><p>Gets the version of the running python.</p>
 287 <table class="docutils field-list" frame="void" rules="none">
 288 <col class="field-name" />
 289 <col class="field-body" />
 290 <tbody valign="top">
 291 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the version of the running python.</td>
 292 </tr>
 293 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>
 294 </tr>
 295 </tbody>
 296 </table>
 297 </dd></dl>
 298
 299 <dl class="function">
 300 <dt id="src.architecture.get_user">
 301 <code class="descclassname">src.architecture.</code><code class="descname">get_user</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/architecture.html#get_user"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.architecture.get_user" title="Permalink to this definition">¶</a></dt>
 302 <dd><p>method that gets the username that launched sat</p>
 303 <table class="docutils field-list" frame="void" rules="none">
 304 <col class="field-name" />
 305 <col class="field-body" />
 306 <tbody valign="top">
 307 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
 308 </tr>
 309 </tbody>
 310 </table>
 311 </dd></dl>
 312
 313 <dl class="function">
 314 <dt id="src.architecture.is_windows">
 315 <code class="descclassname">src.architecture.</code><code class="descname">is_windows</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/architecture.html#is_windows"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.architecture.is_windows" title="Permalink to this definition">¶</a></dt>
 316 <dd><p>method that checks windows OS</p>
 317 <table class="docutils field-list" frame="void" rules="none">
 318 <col class="field-name" />
 319 <col class="field-body" />
 320 <tbody valign="top">
 321 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
 322 </tr>
 323 </tbody>
 324 </table>
 325 </dd></dl>
 326
 327 </div>
 328 <div class="section" id="module-src.compilation">
 329 <span id="src-compilation-module"></span><h2>src.compilation module<a class="headerlink" href="#module-src.compilation" title="Permalink to this headline">¶</a></h2>
 330 <dl class="class">
 331 <dt id="src.compilation.Builder">
 332 <em class="property">class </em><code class="descclassname">src.compilation.</code><code class="descname">Builder</code><span class="sig-paren">(</span><em>config</em>, <em>logger</em>, <em>product_info</em>, <em>options=OptResult(   )</em>, <em>check_src=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder" title="Permalink to this definition">¶</a></dt>
 333 <dd><p>Class to handle all construction steps, like cmake, configure, make, …</p>
 334 <dl class="method">
 335 <dt id="src.compilation.Builder.build_configure">
 336 <code class="descname">build_configure</code><span class="sig-paren">(</span><em>options=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.build_configure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.build_configure" title="Permalink to this definition">¶</a></dt>
 337 <dd></dd></dl>
 338
 339 <dl class="method">
 340 <dt id="src.compilation.Builder.check">
 341 <code class="descname">check</code><span class="sig-paren">(</span><em>command=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.check"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.check" title="Permalink to this definition">¶</a></dt>
 342 <dd></dd></dl>
 343
 344 <dl class="method">
 345 <dt id="src.compilation.Builder.cmake">
 346 <code class="descname">cmake</code><span class="sig-paren">(</span><em>options=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.cmake"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.cmake" title="Permalink to this definition">¶</a></dt>
 347 <dd></dd></dl>
 348
 349 <dl class="method">
 350 <dt id="src.compilation.Builder.complete_environment">
 351 <code class="descname">complete_environment</code><span class="sig-paren">(</span><em>make_options</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.complete_environment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.complete_environment" title="Permalink to this definition">¶</a></dt>
 352 <dd></dd></dl>
 353
 354 <dl class="method">
 355 <dt id="src.compilation.Builder.configure">
 356 <code class="descname">configure</code><span class="sig-paren">(</span><em>options=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.configure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.configure" title="Permalink to this definition">¶</a></dt>
 357 <dd></dd></dl>
 358
 359 <dl class="method">
 360 <dt id="src.compilation.Builder.do_batch_script_build">
 361 <code class="descname">do_batch_script_build</code><span class="sig-paren">(</span><em>script</em>, <em>nb_proc</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.do_batch_script_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.do_batch_script_build" title="Permalink to this definition">¶</a></dt>
 362 <dd></dd></dl>
 363
 364 <dl class="method">
 365 <dt id="src.compilation.Builder.do_default_build">
 366 <code class="descname">do_default_build</code><span class="sig-paren">(</span><em>build_conf_options=''</em>, <em>configure_options=''</em>, <em>show_warning=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.do_default_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.do_default_build" title="Permalink to this definition">¶</a></dt>
 367 <dd></dd></dl>
 368
 369 <dl class="method">
 370 <dt id="src.compilation.Builder.do_python_script_build">
 371 <code class="descname">do_python_script_build</code><span class="sig-paren">(</span><em>script</em>, <em>nb_proc</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.do_python_script_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.do_python_script_build" title="Permalink to this definition">¶</a></dt>
 372 <dd></dd></dl>
 373
 374 <dl class="method">
 375 <dt id="src.compilation.Builder.do_script_build">
 376 <code class="descname">do_script_build</code><span class="sig-paren">(</span><em>script</em>, <em>number_of_proc=0</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.do_script_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.do_script_build" title="Permalink to this definition">¶</a></dt>
 377 <dd></dd></dl>
 378
 379 <dl class="method">
 380 <dt id="src.compilation.Builder.hack_libtool">
 381 <code class="descname">hack_libtool</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.hack_libtool"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.hack_libtool" title="Permalink to this definition">¶</a></dt>
 382 <dd></dd></dl>
 383
 384 <dl class="method">
 385 <dt id="src.compilation.Builder.install">
 386 <code class="descname">install</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.install"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.install" title="Permalink to this definition">¶</a></dt>
 387 <dd></dd></dl>
 388
 389 <dl class="method">
 390 <dt id="src.compilation.Builder.log">
 391 <code class="descname">log</code><span class="sig-paren">(</span><em>text</em>, <em>level</em>, <em>showInfo=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.log" title="Permalink to this definition">¶</a></dt>
 392 <dd></dd></dl>
 393
 394 <dl class="method">
 395 <dt id="src.compilation.Builder.log_command">
 396 <code class="descname">log_command</code><span class="sig-paren">(</span><em>command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.log_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.log_command" title="Permalink to this definition">¶</a></dt>
 397 <dd></dd></dl>
 398
 399 <dl class="method">
 400 <dt id="src.compilation.Builder.make">
 401 <code class="descname">make</code><span class="sig-paren">(</span><em>nb_proc</em>, <em>make_opt=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.make"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.make" title="Permalink to this definition">¶</a></dt>
 402 <dd></dd></dl>
 403
 404 <dl class="method">
 405 <dt id="src.compilation.Builder.prepare">
 406 <code class="descname">prepare</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.prepare"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.prepare" title="Permalink to this definition">¶</a></dt>
 407 <dd></dd></dl>
 408
 409 <dl class="method">
 410 <dt id="src.compilation.Builder.put_txt_log_in_appli_log_dir">
 411 <code class="descname">put_txt_log_in_appli_log_dir</code><span class="sig-paren">(</span><em>file_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.put_txt_log_in_appli_log_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.put_txt_log_in_appli_log_dir" title="Permalink to this definition">¶</a></dt>
 412 <dd><dl class="docutils">
 413 <dt>Put the txt log (that contain the system logs, like make command</dt>
 414 <dd>output) in the directory &lt;APPLICATION DIR&gt;/LOGS/&lt;product_name&gt;/</dd>
 415 </dl>
 416 <table class="docutils field-list" frame="void" rules="none">
 417 <col class="field-name" />
 418 <col class="field-body" />
 419 <tbody valign="top">
 420 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Str</strong> (<em>file_name</em>) – the name of the file to write</td>
 421 </tr>
 422 </tbody>
 423 </table>
 424 </dd></dl>
 425
 426 <dl class="method">
 427 <dt id="src.compilation.Builder.wmake">
 428 <code class="descname">wmake</code><span class="sig-paren">(</span><em>nb_proc</em>, <em>opt_nb_proc=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/compilation.html#Builder.wmake"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.compilation.Builder.wmake" title="Permalink to this definition">¶</a></dt>
 429 <dd></dd></dl>
 430
 431 </dd></dl>
 432
 433 </div>
 434 <div class="section" id="module-src.debug">
 435 <span id="src-debug-module"></span><h2>src.debug module<a class="headerlink" href="#module-src.debug" title="Permalink to this headline">¶</a></h2>
 436 <p>This file assume DEBUG functionalities use</p>
 437 <ul class="simple">
 438 <li>print debug messages in sys.stderr for salomeTools</li>
 439 <li>show pretty print debug representation from instances of SAT classes
 440 (pretty print src.pyconf.Config), and python dict/list etc. (as ‘aVariable’)</li>
 441 </ul>
 442 <p>WARNING: obviously supposedly show messages in SAT development phase, not production</p>
 443 <p>usage:
 444 &gt;&gt; import debug as DBG
 445 &gt;&gt; DBG.write(“aTitle”, aVariable)        # not shown in production
 446 &gt;&gt; DBG.write(“aTitle”, aVariable, True)  # unconditionaly shown (as show=True)</p>
 447 <p>to set show message as development phase:
 448 &gt;&gt; DBG.push_debug(True)</p>
 449 <p>to set no show message as production phase:
 450 &gt;&gt; DBG.push_debug(False)</p>
 451 <p>to set show message temporary as development phase, only in a method:
 452 &gt;&gt; def aMethodToDebug(…):
 453 &gt;&gt;   DBG.push_debug(True)              #force show as appended status
 454 &gt;&gt;   etc. method code with some DBG.write()
 455 &gt;&gt;   DBG.pop_debug()                   #restore previous status (show or not show)
 456 &gt;&gt;   return</p>
 457 <p>to set a message for future fix, as temporary problem to not forget:
 458 DBG.tofix(“aTitle”, aVariable, True/False) #True/False in production shown, or not</p>
 459 <p>in command line interface you could redirect stderr to file ‘myDebug.log’:
 460 &gt;&gt; sat compile … 2&gt; myDebug.log   # only stderr
 461 &gt;&gt; sat compile … &amp;&gt; myDebug.log   # stdout and stderr</p>
 462 <dl class="class">
 463 <dt id="src.debug.InStream">
 464 <em class="property">class </em><code class="descclassname">src.debug.</code><code class="descname">InStream</code><span class="sig-paren">(</span><em>buf=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/debug.html#InStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.debug.InStream" title="Permalink to this definition">¶</a></dt>
 465 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StringIO.StringIO</span></code></p>
 466 <p>utility class for pyconf.Config input iostream</p>
 467 </dd></dl>
 468
 469 <dl class="class">
 470 <dt id="src.debug.OutStream">
 471 <em class="property">class </em><code class="descclassname">src.debug.</code><code class="descname">OutStream</code><span class="sig-paren">(</span><em>buf=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/debug.html#OutStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.debug.OutStream" title="Permalink to this definition">¶</a></dt>
 472 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StringIO.StringIO</span></code></p>
 473 <p>utility class for pyconf.Config output iostream</p>
 474 <dl class="method">
 475 <dt id="src.debug.OutStream.close">
 476 <code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/debug.html#OutStream.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.debug.OutStream.close" title="Permalink to this definition">¶</a></dt>
 477 <dd><p>because Config.__save__ calls close() stream as file
 478 keep value before lost as self.value</p>
 479 </dd></dl>
 480
 481 </dd></dl>
 482
 483 <dl class="function">
 484 <dt id="src.debug.getLocalEnv">
 485 <code class="descclassname">src.debug.</code><code class="descname">getLocalEnv</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/debug.html#getLocalEnv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.debug.getLocalEnv" title="Permalink to this definition">¶</a></dt>
 486 <dd><p>get string for environment variables representation</p>
 487 </dd></dl>
 488
 489 <dl class="function">
 490 <dt id="src.debug.getStrConfigDbg">
 491 <code class="descclassname">src.debug.</code><code class="descname">getStrConfigDbg</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/debug.html#getStrConfigDbg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.debug.getStrConfigDbg" title="Permalink to this definition">¶</a></dt>
 492 <dd><p>set string as saveConfigDbg,
 493 as (path expression evaluation) for debug</p>
 494 </dd></dl>
 495
 496 <dl class="function">
 497 <dt id="src.debug.getStrConfigStd">
 498 <code class="descclassname">src.debug.</code><code class="descname">getStrConfigStd</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/debug.html#getStrConfigStd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.debug.getStrConfigStd" title="Permalink to this definition">¶</a></dt>
 499 <dd><p>set string as saveConfigStd, as file .pyconf</p>
 500 </dd></dl>
 501
 502 <dl class="function">
 503 <dt id="src.debug.indent">
 504 <code class="descclassname">src.debug.</code><code class="descname">indent</code><span class="sig-paren">(</span><em>text</em>, <em>amount=2</em>, <em>ch=' '</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/debug.html#indent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.debug.indent" title="Permalink to this definition">¶</a></dt>
 505 <dd><p>indent multi lines message</p>
 506 </dd></dl>
 507
 508 <dl class="function">
 509 <dt id="src.debug.pop_debug">
 510 <code class="descclassname">src.debug.</code><code class="descname">pop_debug</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/debug.html#pop_debug"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.debug.pop_debug" title="Permalink to this definition">¶</a></dt>
 511 <dd><p>restore previous debug outputs status</p>
 512 </dd></dl>
 513
 514 <dl class="function">
 515 <dt id="src.debug.push_debug">
 516 <code class="descclassname">src.debug.</code><code class="descname">push_debug</code><span class="sig-paren">(</span><em>aBool</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/debug.html#push_debug"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.debug.push_debug" title="Permalink to this definition">¶</a></dt>
 517 <dd><p>set debug outputs activated, or not</p>
 518 </dd></dl>
 519
 520 <dl class="function">
 521 <dt id="src.debug.saveConfigDbg">
 522 <code class="descclassname">src.debug.</code><code class="descname">saveConfigDbg</code><span class="sig-paren">(</span><em>config</em>, <em>aStream</em>, <em>indent=0</em>, <em>path=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/debug.html#saveConfigDbg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.debug.saveConfigDbg" title="Permalink to this definition">¶</a></dt>
 523 <dd><p>pyconf returns multilines (path expression evaluation) for debug</p>
 524 </dd></dl>
 525
 526 <dl class="function">
 527 <dt id="src.debug.saveConfigStd">
 528 <code class="descclassname">src.debug.</code><code class="descname">saveConfigStd</code><span class="sig-paren">(</span><em>config</em>, <em>aStream</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/debug.html#saveConfigStd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.debug.saveConfigStd" title="Permalink to this definition">¶</a></dt>
 529 <dd><p>returns as file .pyconf</p>
 530 </dd></dl>
 531
 532 <dl class="function">
 533 <dt id="src.debug.tofix">
 534 <code class="descclassname">src.debug.</code><code class="descname">tofix</code><span class="sig-paren">(</span><em>title</em>, <em>var=''</em>, <em>force=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/debug.html#tofix"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.debug.tofix" title="Permalink to this definition">¶</a></dt>
 535 <dd><p>write sys.stderr a message if _debug[-1]==True or optionaly force=True
 536 use this only if no logger accessible for classic
 537 logger.warning(message) or logger.debug(message)</p>
 538 </dd></dl>
 539
 540 <dl class="function">
 541 <dt id="src.debug.write">
 542 <code class="descclassname">src.debug.</code><code class="descname">write</code><span class="sig-paren">(</span><em>title</em>, <em>var=''</em>, <em>force=None</em>, <em>fmt='\n#### DEBUG: %s:\n%s\n'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/debug.html#write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.debug.write" title="Permalink to this definition">¶</a></dt>
 543 <dd><p>write sys.stderr a message if _debug[-1]==True or optionaly force=True</p>
 544 </dd></dl>
 545
 546 </div>
 547 <div class="section" id="module-src.environment">
 548 <span id="src-environment-module"></span><h2>src.environment module<a class="headerlink" href="#module-src.environment" title="Permalink to this headline">¶</a></h2>
 549 <dl class="class">
 550 <dt id="src.environment.Environ">
 551 <em class="property">class </em><code class="descclassname">src.environment.</code><code class="descname">Environ</code><span class="sig-paren">(</span><em>environ=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#Environ"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.Environ" title="Permalink to this definition">¶</a></dt>
 552 <dd><p>Class to manage the environment context</p>
 553 <dl class="method">
 554 <dt id="src.environment.Environ.append">
 555 <code class="descname">append</code><span class="sig-paren">(</span><em>key</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#Environ.append"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.Environ.append" title="Permalink to this definition">¶</a></dt>
 556 <dd><p>Same as append_value but the value argument can be a list</p>
 557 <table class="docutils field-list" frame="void" rules="none">
 558 <col class="field-name" />
 559 <col class="field-body" />
 560 <tbody valign="top">
 561 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 562 <li><strong>str</strong> (<em>sep</em>) – the environment variable to append</li>
 563 <li><strong>str</strong><strong> or </strong><strong>list</strong> (<em>value</em>) – the value(s) to append to key</li>
 564 <li><strong>str</strong> – the separator string</li>
 565 </ul>
 566 </td>
 567 </tr>
 568 </tbody>
 569 </table>
 570 </dd></dl>
 571
 572 <dl class="method">
 573 <dt id="src.environment.Environ.append_value">
 574 <code class="descname">append_value</code><span class="sig-paren">(</span><em>key</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#Environ.append_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.Environ.append_value" title="Permalink to this definition">¶</a></dt>
 575 <dd><p>append value to key using sep</p>
 576 <table class="docutils field-list" frame="void" rules="none">
 577 <col class="field-name" />
 578 <col class="field-body" />
 579 <tbody valign="top">
 580 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 581 <li><strong>str</strong> (<em>sep</em>) – the environment variable to append</li>
 582 <li><strong>str</strong> – the value to append to key</li>
 583 <li><strong>str</strong> – the separator string</li>
 584 </ul>
 585 </td>
 586 </tr>
 587 </tbody>
 588 </table>
 589 </dd></dl>
 590
 591 <dl class="method">
 592 <dt id="src.environment.Environ.command_value">
 593 <code class="descname">command_value</code><span class="sig-paren">(</span><em>key</em>, <em>command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#Environ.command_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.Environ.command_value" title="Permalink to this definition">¶</a></dt>
 594 <dd><p>Get the value given by the system command “command”
 595 and put it in the environment variable key</p>
 596 <table class="docutils field-list" frame="void" rules="none">
 597 <col class="field-name" />
 598 <col class="field-body" />
 599 <tbody valign="top">
 600 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 601 <li><strong>str</strong> (<em>command</em>) – the environment variable</li>
 602 <li><strong>str</strong> – the command to execute</li>
 603 </ul>
 604 </td>
 605 </tr>
 606 </tbody>
 607 </table>
 608 </dd></dl>
 609
 610 <dl class="method">
 611 <dt id="src.environment.Environ.get">
 612 <code class="descname">get</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#Environ.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.Environ.get" title="Permalink to this definition">¶</a></dt>
 613 <dd><p>Get the value of the environment variable “key”</p>
 614 <table class="docutils field-list" frame="void" rules="none">
 615 <col class="field-name" />
 616 <col class="field-body" />
 617 <tbody valign="top">
 618 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable</td>
 619 </tr>
 620 </tbody>
 621 </table>
 622 </dd></dl>
 623
 624 <dl class="method">
 625 <dt id="src.environment.Environ.is_defined">
 626 <code class="descname">is_defined</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#Environ.is_defined"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.Environ.is_defined" title="Permalink to this definition">¶</a></dt>
 627 <dd><p>Check if the key exists in the environment</p>
 628 <table class="docutils field-list" frame="void" rules="none">
 629 <col class="field-name" />
 630 <col class="field-body" />
 631 <tbody valign="top">
 632 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable to check</td>
 633 </tr>
 634 </tbody>
 635 </table>
 636 </dd></dl>
 637
 638 <dl class="method">
 639 <dt id="src.environment.Environ.prepend">
 640 <code class="descname">prepend</code><span class="sig-paren">(</span><em>key</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#Environ.prepend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.Environ.prepend" title="Permalink to this definition">¶</a></dt>
 641 <dd><p>Same as prepend_value but the value argument can be a list</p>
 642 <table class="docutils field-list" frame="void" rules="none">
 643 <col class="field-name" />
 644 <col class="field-body" />
 645 <tbody valign="top">
 646 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 647 <li><strong>str</strong> (<em>sep</em>) – the environment variable to prepend</li>
 648 <li><strong>str</strong><strong> or </strong><strong>list</strong> (<em>value</em>) – the value(s) to prepend to key</li>
 649 <li><strong>str</strong> – the separator string</li>
 650 </ul>
 651 </td>
 652 </tr>
 653 </tbody>
 654 </table>
 655 </dd></dl>
 656
 657 <dl class="method">
 658 <dt id="src.environment.Environ.prepend_value">
 659 <code class="descname">prepend_value</code><span class="sig-paren">(</span><em>key</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#Environ.prepend_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.Environ.prepend_value" title="Permalink to this definition">¶</a></dt>
 660 <dd><p>prepend value to key using sep</p>
 661 <table class="docutils field-list" frame="void" rules="none">
 662 <col class="field-name" />
 663 <col class="field-body" />
 664 <tbody valign="top">
 665 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 666 <li><strong>str</strong> (<em>sep</em>) – the environment variable to prepend</li>
 667 <li><strong>str</strong> – the value to prepend to key</li>
 668 <li><strong>str</strong> – the separator string</li>
 669 </ul>
 670 </td>
 671 </tr>
 672 </tbody>
 673 </table>
 674 </dd></dl>
 675
 676 <dl class="method">
 677 <dt id="src.environment.Environ.set">
 678 <code class="descname">set</code><span class="sig-paren">(</span><em>key</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#Environ.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.Environ.set" title="Permalink to this definition">¶</a></dt>
 679 <dd><p>Set the environment variable “key” to value “value”</p>
 680 <table class="docutils field-list" frame="void" rules="none">
 681 <col class="field-name" />
 682 <col class="field-body" />
 683 <tbody valign="top">
 684 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 685 <li><strong>str</strong> (<em>value</em>) – the environment variable to set</li>
 686 <li><strong>str</strong> – the value</li>
 687 </ul>
 688 </td>
 689 </tr>
 690 </tbody>
 691 </table>
 692 </dd></dl>
 693
 694 </dd></dl>
 695
 696 <dl class="class">
 697 <dt id="src.environment.FileEnvWriter">
 698 <em class="property">class </em><code class="descclassname">src.environment.</code><code class="descname">FileEnvWriter</code><span class="sig-paren">(</span><em>config</em>, <em>logger</em>, <em>out_dir</em>, <em>src_root</em>, <em>env_info=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#FileEnvWriter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.FileEnvWriter" title="Permalink to this definition">¶</a></dt>
 699 <dd><p>Class to dump the environment to a file.</p>
 700 <dl class="method">
 701 <dt id="src.environment.FileEnvWriter.write_cfgForPy_file">
 702 <code class="descname">write_cfgForPy_file</code><span class="sig-paren">(</span><em>filename</em>, <em>additional_env={}</em>, <em>for_package=None</em>, <em>with_commercial=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#FileEnvWriter.write_cfgForPy_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.FileEnvWriter.write_cfgForPy_file" title="Permalink to this definition">¶</a></dt>
 703 <dd><p>Append to current opened aFile a cfgForPy
 704 environment (SALOME python launcher).</p>
 705 <table class="docutils field-list" frame="void" rules="none">
 706 <col class="field-name" />
 707 <col class="field-body" />
 708 <tbody valign="top">
 709 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 710 <li><strong>str</strong> (<em>for_package</em>) – the file path</li>
 711 <li><strong>dict</strong> (<em>additional_env</em>) – a dictionary of additional variables
 712 to add to the environment</li>
 713 <li><strong>str</strong> – If not None, produce a relative environment
 714 designed for a package.</li>
 715 </ul>
 716 </td>
 717 </tr>
 718 </tbody>
 719 </table>
 720 </dd></dl>
 721
 722 <dl class="method">
 723 <dt id="src.environment.FileEnvWriter.write_env_file">
 724 <code class="descname">write_env_file</code><span class="sig-paren">(</span><em>filename</em>, <em>forBuild</em>, <em>shell</em>, <em>for_package=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#FileEnvWriter.write_env_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.FileEnvWriter.write_env_file" title="Permalink to this definition">¶</a></dt>
 725 <dd><p>Create an environment file.</p>
 726 <table class="docutils field-list" frame="void" rules="none">
 727 <col class="field-name" />
 728 <col class="field-body" />
 729 <tbody valign="top">
 730 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 731 <li><strong>str</strong> (<em>shell</em>) – the file path</li>
 732 <li><strong>bool</strong> (<em>forBuild</em>) – if true, the build environment</li>
 733 <li><strong>str</strong> – the type of file wanted (.sh, .bat)</li>
 734 </ul>
 735 </td>
 736 </tr>
 737 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The path to the generated file</p>
 738 </td>
 739 </tr>
 740 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
 741 </td>
 742 </tr>
 743 </tbody>
 744 </table>
 745 </dd></dl>
 746
 747 </dd></dl>
 748
 749 <dl class="class">
 750 <dt id="src.environment.SalomeEnviron">
 751 <em class="property">class </em><code class="descclassname">src.environment.</code><code class="descname">SalomeEnviron</code><span class="sig-paren">(</span><em>cfg</em>, <em>environ</em>, <em>forBuild=False</em>, <em>for_package=None</em>, <em>enable_simple_env_script=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron" title="Permalink to this definition">¶</a></dt>
 752 <dd><p>Class to manage the environment of SALOME.</p>
 753 <dl class="method">
 754 <dt id="src.environment.SalomeEnviron.add_comment">
 755 <code class="descname">add_comment</code><span class="sig-paren">(</span><em>comment</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.add_comment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.add_comment" title="Permalink to this definition">¶</a></dt>
 756 <dd><p>Add a commentary to the out stream (in case of file generation)</p>
 757 <table class="docutils field-list" frame="void" rules="none">
 758 <col class="field-name" />
 759 <col class="field-body" />
 760 <tbody valign="top">
 761 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>comment</em>) – the commentary to add</td>
 762 </tr>
 763 </tbody>
 764 </table>
 765 </dd></dl>
 766
 767 <dl class="method">
 768 <dt id="src.environment.SalomeEnviron.add_line">
 769 <code class="descname">add_line</code><span class="sig-paren">(</span><em>nb_line</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.add_line"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.add_line" title="Permalink to this definition">¶</a></dt>
 770 <dd><p>Add empty lines to the out stream (in case of file generation)</p>
 771 <table class="docutils field-list" frame="void" rules="none">
 772 <col class="field-name" />
 773 <col class="field-body" />
 774 <tbody valign="top">
 775 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>int</strong> (<em>nb_line</em>) – the number of empty lines to add</td>
 776 </tr>
 777 </tbody>
 778 </table>
 779 </dd></dl>
 780
 781 <dl class="method">
 782 <dt id="src.environment.SalomeEnviron.add_warning">
 783 <code class="descname">add_warning</code><span class="sig-paren">(</span><em>warning</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.add_warning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.add_warning" title="Permalink to this definition">¶</a></dt>
 784 <dd><p>Add a warning to the out stream (in case of file generation)</p>
 785 <table class="docutils field-list" frame="void" rules="none">
 786 <col class="field-name" />
 787 <col class="field-body" />
 788 <tbody valign="top">
 789 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>warning</em>) – the warning to add</td>
 790 </tr>
 791 </tbody>
 792 </table>
 793 </dd></dl>
 794
 795 <dl class="method">
 796 <dt id="src.environment.SalomeEnviron.append">
 797 <code class="descname">append</code><span class="sig-paren">(</span><em>key</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.append"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.append" title="Permalink to this definition">¶</a></dt>
 798 <dd><p>append value to key using sep</p>
 799 <table class="docutils field-list" frame="void" rules="none">
 800 <col class="field-name" />
 801 <col class="field-body" />
 802 <tbody valign="top">
 803 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 804 <li><strong>str</strong> (<em>sep</em>) – the environment variable to append</li>
 805 <li><strong>str</strong> – the value to append to key</li>
 806 <li><strong>str</strong> – the separator string</li>
 807 </ul>
 808 </td>
 809 </tr>
 810 </tbody>
 811 </table>
 812 </dd></dl>
 813
 814 <dl class="method">
 815 <dt id="src.environment.SalomeEnviron.dump">
 816 <code class="descname">dump</code><span class="sig-paren">(</span><em>out</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.dump"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.dump" title="Permalink to this definition">¶</a></dt>
 817 <dd><p>Write the environment to out</p>
 818 <table class="docutils field-list" frame="void" rules="none">
 819 <col class="field-name" />
 820 <col class="field-body" />
 821 <tbody valign="top">
 822 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>file</strong> (<em>out</em>) – the stream where to write the environment</td>
 823 </tr>
 824 </tbody>
 825 </table>
 826 </dd></dl>
 827
 828 <dl class="method">
 829 <dt id="src.environment.SalomeEnviron.finish">
 830 <code class="descname">finish</code><span class="sig-paren">(</span><em>required</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.finish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.finish" title="Permalink to this definition">¶</a></dt>
 831 <dd><p>Add a final instruction in the out file (in case of file generation)</p>
 832 <table class="docutils field-list" frame="void" rules="none">
 833 <col class="field-name" />
 834 <col class="field-body" />
 835 <tbody valign="top">
 836 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bool</strong> (<em>required</em>) – Do nothing if required is False</td>
 837 </tr>
 838 </tbody>
 839 </table>
 840 </dd></dl>
 841
 842 <dl class="method">
 843 <dt id="src.environment.SalomeEnviron.get">
 844 <code class="descname">get</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.get" title="Permalink to this definition">¶</a></dt>
 845 <dd><p>Get the value of the environment variable “key”</p>
 846 <table class="docutils field-list" frame="void" rules="none">
 847 <col class="field-name" />
 848 <col class="field-body" />
 849 <tbody valign="top">
 850 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable</td>
 851 </tr>
 852 </tbody>
 853 </table>
 854 </dd></dl>
 855
 856 <dl class="method">
 857 <dt id="src.environment.SalomeEnviron.get_names">
 858 <code class="descname">get_names</code><span class="sig-paren">(</span><em>lProducts</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.get_names"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.get_names" title="Permalink to this definition">¶</a></dt>
 859 <dd><p>Get the products name to add in SALOME_MODULES environment variable
 860 It is the name of the product, except in the case where the is a
 861 component name. And it has to be in SALOME_MODULES variable only
 862 if the product has the property has_salome_hui = “yes”</p>
 863 <table class="docutils field-list" frame="void" rules="none">
 864 <col class="field-name" />
 865 <col class="field-body" />
 866 <tbody valign="top">
 867 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>list</strong> (<em>lProducts</em>) – List of products to potentially add</td>
 868 </tr>
 869 </tbody>
 870 </table>
 871 </dd></dl>
 872
 873 <dl class="method">
 874 <dt id="src.environment.SalomeEnviron.is_defined">
 875 <code class="descname">is_defined</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.is_defined"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.is_defined" title="Permalink to this definition">¶</a></dt>
 876 <dd><p>Check if the key exists in the environment</p>
 877 <table class="docutils field-list" frame="void" rules="none">
 878 <col class="field-name" />
 879 <col class="field-body" />
 880 <tbody valign="top">
 881 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable to check</td>
 882 </tr>
 883 </tbody>
 884 </table>
 885 </dd></dl>
 886
 887 <dl class="method">
 888 <dt id="src.environment.SalomeEnviron.load_cfg_environment">
 889 <code class="descname">load_cfg_environment</code><span class="sig-paren">(</span><em>cfg_env</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.load_cfg_environment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.load_cfg_environment" title="Permalink to this definition">¶</a></dt>
 890 <dd><p>Loads environment defined in cfg_env</p>
 891 <table class="docutils field-list" frame="void" rules="none">
 892 <col class="field-name" />
 893 <col class="field-body" />
 894 <tbody valign="top">
 895 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>cfg_env</em>) – A config containing an environment</td>
 896 </tr>
 897 </tbody>
 898 </table>
 899 </dd></dl>
 900
 901 <dl class="method">
 902 <dt id="src.environment.SalomeEnviron.prepend">
 903 <code class="descname">prepend</code><span class="sig-paren">(</span><em>key</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.prepend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.prepend" title="Permalink to this definition">¶</a></dt>
 904 <dd><p>prepend value to key using sep</p>
 905 <table class="docutils field-list" frame="void" rules="none">
 906 <col class="field-name" />
 907 <col class="field-body" />
 908 <tbody valign="top">
 909 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 910 <li><strong>str</strong> (<em>sep</em>) – the environment variable to prepend</li>
 911 <li><strong>str</strong> – the value to prepend to key</li>
 912 <li><strong>str</strong> – the separator string</li>
 913 </ul>
 914 </td>
 915 </tr>
 916 </tbody>
 917 </table>
 918 </dd></dl>
 919
 920 <dl class="method">
 921 <dt id="src.environment.SalomeEnviron.run_env_script">
 922 <code class="descname">run_env_script</code><span class="sig-paren">(</span><em>product_info</em>, <em>logger=None</em>, <em>native=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.run_env_script"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.run_env_script" title="Permalink to this definition">¶</a></dt>
 923 <dd><p>Runs an environment script.</p>
 924 <table class="docutils field-list" frame="void" rules="none">
 925 <col class="field-name" />
 926 <col class="field-body" />
 927 <tbody valign="top">
 928 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 929 <li><strong>Config</strong> (<em>product_info</em>) – The product description</li>
 930 <li><strong>Logger</strong> (<em>logger</em>) – The logger instance to display messages</li>
 931 <li><strong>Boolean</strong> (<em>native</em>) – if True load set_native_env instead of set_env</li>
 932 </ul>
 933 </td>
 934 </tr>
 935 </tbody>
 936 </table>
 937 </dd></dl>
 938
 939 <dl class="method">
 940 <dt id="src.environment.SalomeEnviron.run_simple_env_script">
 941 <code class="descname">run_simple_env_script</code><span class="sig-paren">(</span><em>script_path</em>, <em>logger=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.run_simple_env_script"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.run_simple_env_script" title="Permalink to this definition">¶</a></dt>
 942 <dd><p>Runs an environment script. Same as run_env_script, but with a
 943 script path as parameter.</p>
 944 <table class="docutils field-list" frame="void" rules="none">
 945 <col class="field-name" />
 946 <col class="field-body" />
 947 <tbody valign="top">
 948 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 949 <li><strong>str</strong> (<em>script_path</em>) – a path to an environment script</li>
 950 <li><strong>Logger</strong> (<em>logger</em>) – The logger instance to display messages</li>
 951 </ul>
 952 </td>
 953 </tr>
 954 </tbody>
 955 </table>
 956 </dd></dl>
 957
 958 <dl class="method">
 959 <dt id="src.environment.SalomeEnviron.set">
 960 <code class="descname">set</code><span class="sig-paren">(</span><em>key</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.set" title="Permalink to this definition">¶</a></dt>
 961 <dd><p>Set the environment variable “key” to value “value”</p>
 962 <table class="docutils field-list" frame="void" rules="none">
 963 <col class="field-name" />
 964 <col class="field-body" />
 965 <tbody valign="top">
 966 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 967 <li><strong>str</strong> (<em>value</em>) – the environment variable to set</li>
 968 <li><strong>str</strong> – the value</li>
 969 </ul>
 970 </td>
 971 </tr>
 972 </tbody>
 973 </table>
 974 </dd></dl>
 975
 976 <dl class="method">
 977 <dt id="src.environment.SalomeEnviron.set_a_product">
 978 <code class="descname">set_a_product</code><span class="sig-paren">(</span><em>product</em>, <em>logger</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.set_a_product"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.set_a_product" title="Permalink to this definition">¶</a></dt>
 979 <dd><p>Sets the environment of a product.</p>
 980 <table class="docutils field-list" frame="void" rules="none">
 981 <col class="field-name" />
 982 <col class="field-body" />
 983 <tbody valign="top">
 984 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 985 <li><strong>str</strong> (<em>product</em>) – The product name</li>
 986 <li><strong>Logger</strong> (<em>logger</em>) – The logger instance to display messages</li>
 987 </ul>
 988 </td>
 989 </tr>
 990 </tbody>
 991 </table>
 992 </dd></dl>
 993
 994 <dl class="method">
 995 <dt id="src.environment.SalomeEnviron.set_application_env">
 996 <code class="descname">set_application_env</code><span class="sig-paren">(</span><em>logger</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.set_application_env"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.set_application_env" title="Permalink to this definition">¶</a></dt>
 997 <dd><p>Sets the environment defined in the APPLICATION file.</p>
 998 <table class="docutils field-list" frame="void" rules="none">
 999 <col class="field-name" />
1000 <col class="field-body" />
1001 <tbody valign="top">
1002 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Logger</strong> (<em>logger</em>) – The logger instance to display messages</td>
1003 </tr>
1004 </tbody>
1005 </table>
1006 </dd></dl>
1007
1008 <dl class="method">
1009 <dt id="src.environment.SalomeEnviron.set_cpp_env">
1010 <code class="descname">set_cpp_env</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.set_cpp_env"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.set_cpp_env" title="Permalink to this definition">¶</a></dt>
1011 <dd><p>Sets the generic environment for a SALOME cpp product.</p>
1012 <table class="docutils field-list" frame="void" rules="none">
1013 <col class="field-name" />
1014 <col class="field-body" />
1015 <tbody valign="top">
1016 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The product description</td>
1017 </tr>
1018 </tbody>
1019 </table>
1020 </dd></dl>
1021
1022 <dl class="method">
1023 <dt id="src.environment.SalomeEnviron.set_full_environ">
1024 <code class="descname">set_full_environ</code><span class="sig-paren">(</span><em>logger</em>, <em>env_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.set_full_environ"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.set_full_environ" title="Permalink to this definition">¶</a></dt>
1025 <dd><p>Sets the full environment for products
1026 specified in env_info dictionary.</p>
1027 <table class="docutils field-list" frame="void" rules="none">
1028 <col class="field-name" />
1029 <col class="field-body" />
1030 <tbody valign="top">
1031 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1032 <li><strong>Logger</strong> (<em>logger</em>) – The logger instance to display messages</li>
1033 <li><strong>list</strong> (<em>env_info</em>) – the list of products</li>
1034 </ul>
1035 </td>
1036 </tr>
1037 </tbody>
1038 </table>
1039 </dd></dl>
1040
1041 <dl class="method">
1042 <dt id="src.environment.SalomeEnviron.set_products">
1043 <code class="descname">set_products</code><span class="sig-paren">(</span><em>logger</em>, <em>src_root=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.set_products"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.set_products" title="Permalink to this definition">¶</a></dt>
1044 <dd><p>Sets the environment for all the products.</p>
1045 <table class="docutils field-list" frame="void" rules="none">
1046 <col class="field-name" />
1047 <col class="field-body" />
1048 <tbody valign="top">
1049 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1050 <li><strong>Logger</strong> (<em>logger</em>) – The logger instance to display messages</li>
1051 <li><strong>src</strong> (<em>src_root</em>) – the application working directory</li>
1052 </ul>
1053 </td>
1054 </tr>
1055 </tbody>
1056 </table>
1057 </dd></dl>
1058
1059 <dl class="method">
1060 <dt id="src.environment.SalomeEnviron.set_python_libdirs">
1061 <code class="descname">set_python_libdirs</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.set_python_libdirs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.set_python_libdirs" title="Permalink to this definition">¶</a></dt>
1062 <dd><p>Set some generic variables for python library paths</p>
1063 </dd></dl>
1064
1065 <dl class="method">
1066 <dt id="src.environment.SalomeEnviron.set_salome_generic_product_env">
1067 <code class="descname">set_salome_generic_product_env</code><span class="sig-paren">(</span><em>pi</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.set_salome_generic_product_env"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.set_salome_generic_product_env" title="Permalink to this definition">¶</a></dt>
1068 <dd><p>Sets the generic environment for a SALOME product.</p>
1069 <table class="docutils field-list" frame="void" rules="none">
1070 <col class="field-name" />
1071 <col class="field-body" />
1072 <tbody valign="top">
1073 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>pi</em>) – The product description</td>
1074 </tr>
1075 </tbody>
1076 </table>
1077 </dd></dl>
1078
1079 <dl class="method">
1080 <dt id="src.environment.SalomeEnviron.set_salome_minimal_product_env">
1081 <code class="descname">set_salome_minimal_product_env</code><span class="sig-paren">(</span><em>product_info</em>, <em>logger</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#SalomeEnviron.set_salome_minimal_product_env"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.SalomeEnviron.set_salome_minimal_product_env" title="Permalink to this definition">¶</a></dt>
1082 <dd><p>Sets the minimal environment for a SALOME product.
1083 xxx_ROOT_DIR and xxx_SRC_DIR</p>
1084 <table class="docutils field-list" frame="void" rules="none">
1085 <col class="field-name" />
1086 <col class="field-body" />
1087 <tbody valign="top">
1088 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1089 <li><strong>Config</strong> (<em>product_info</em>) – The product description</li>
1090 <li><strong>Logger</strong> (<em>logger</em>) – The logger instance to display messages</li>
1091 </ul>
1092 </td>
1093 </tr>
1094 </tbody>
1095 </table>
1096 </dd></dl>
1097
1098 </dd></dl>
1099
1100 <dl class="class">
1101 <dt id="src.environment.Shell">
1102 <em class="property">class </em><code class="descclassname">src.environment.</code><code class="descname">Shell</code><span class="sig-paren">(</span><em>name</em>, <em>extension</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#Shell"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.Shell" title="Permalink to this definition">¶</a></dt>
1103 <dd><p>Definition of a Shell.</p>
1104 </dd></dl>
1105
1106 <dl class="function">
1107 <dt id="src.environment.load_environment">
1108 <code class="descclassname">src.environment.</code><code class="descname">load_environment</code><span class="sig-paren">(</span><em>config</em>, <em>build</em>, <em>logger</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/environment.html#load_environment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.environment.load_environment" title="Permalink to this definition">¶</a></dt>
1109 <dd><p>Loads the environment (used to run the tests, for example).</p>
1110 <table class="docutils field-list" frame="void" rules="none">
1111 <col class="field-name" />
1112 <col class="field-body" />
1113 <tbody valign="top">
1114 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1115 <li><strong>Config</strong> (<em>config</em>) – the global config</li>
1116 <li><strong>bool</strong> (<em>build</em>) – build environement if True</li>
1117 <li><strong>Logger</strong> (<em>logger</em>) – The logger instance to display messages</li>
1118 </ul>
1119 </td>
1120 </tr>
1121 </tbody>
1122 </table>
1123 </dd></dl>
1124
1125 </div>
1126 <div class="section" id="module-src.fileEnviron">
1127 <span id="src-fileenviron-module"></span><h2>src.fileEnviron module<a class="headerlink" href="#module-src.fileEnviron" title="Permalink to this headline">¶</a></h2>
1128 <dl class="class">
1129 <dt id="src.fileEnviron.BashFileEnviron">
1130 <em class="property">class </em><code class="descclassname">src.fileEnviron.</code><code class="descname">BashFileEnviron</code><span class="sig-paren">(</span><em>output</em>, <em>environ=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#BashFileEnviron"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.BashFileEnviron" title="Permalink to this definition">¶</a></dt>
1131 <dd><p>Bases: <a class="reference internal" href="#src.fileEnviron.FileEnviron" title="src.fileEnviron.FileEnviron"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.fileEnviron.FileEnviron</span></code></a></p>
1132 <p>Class for bash shell.</p>
1133 <dl class="method">
1134 <dt id="src.fileEnviron.BashFileEnviron.command_value">
1135 <code class="descname">command_value</code><span class="sig-paren">(</span><em>key</em>, <em>command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#BashFileEnviron.command_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.BashFileEnviron.command_value" title="Permalink to this definition">¶</a></dt>
1136 <dd><p>Get the value given by the system command “command”
1137 and put it in the environment variable key.
1138 Has to be overwritten in the derived classes
1139 This can be seen as a virtual method</p>
1140 <table class="docutils field-list" frame="void" rules="none">
1141 <col class="field-name" />
1142 <col class="field-body" />
1143 <tbody valign="top">
1144 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1145 <li><strong>str</strong> (<em>command</em>) – the environment variable</li>
1146 <li><strong>str</strong> – the command to execute</li>
1147 </ul>
1148 </td>
1149 </tr>
1150 </tbody>
1151 </table>
1152 </dd></dl>
1153
1154 <dl class="method">
1155 <dt id="src.fileEnviron.BashFileEnviron.finish">
1156 <code class="descname">finish</code><span class="sig-paren">(</span><em>required=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#BashFileEnviron.finish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.BashFileEnviron.finish" title="Permalink to this definition">¶</a></dt>
1157 <dd><p>Add a final instruction in the out file (in case of file generation)</p>
1158 <table class="docutils field-list" frame="void" rules="none">
1159 <col class="field-name" />
1160 <col class="field-body" />
1161 <tbody valign="top">
1162 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bool</strong> (<em>required</em>) – Do nothing if required is False</td>
1163 </tr>
1164 </tbody>
1165 </table>
1166 </dd></dl>
1167
1168 <dl class="method">
1169 <dt id="src.fileEnviron.BashFileEnviron.set">
1170 <code class="descname">set</code><span class="sig-paren">(</span><em>key</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#BashFileEnviron.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.BashFileEnviron.set" title="Permalink to this definition">¶</a></dt>
1171 <dd><p>Set the environment variable “key” to value “value”</p>
1172 <table class="docutils field-list" frame="void" rules="none">
1173 <col class="field-name" />
1174 <col class="field-body" />
1175 <tbody valign="top">
1176 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1177 <li><strong>str</strong> (<em>value</em>) – the environment variable to set</li>
1178 <li><strong>str</strong> – the value</li>
1179 </ul>
1180 </td>
1181 </tr>
1182 </tbody>
1183 </table>
1184 </dd></dl>
1185
1186 </dd></dl>
1187
1188 <dl class="class">
1189 <dt id="src.fileEnviron.BatFileEnviron">
1190 <em class="property">class </em><code class="descclassname">src.fileEnviron.</code><code class="descname">BatFileEnviron</code><span class="sig-paren">(</span><em>output</em>, <em>environ=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#BatFileEnviron"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.BatFileEnviron" title="Permalink to this definition">¶</a></dt>
1191 <dd><p>Bases: <a class="reference internal" href="#src.fileEnviron.FileEnviron" title="src.fileEnviron.FileEnviron"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.fileEnviron.FileEnviron</span></code></a></p>
1192 <p>for Windows batch shell.</p>
1193 <dl class="method">
1194 <dt id="src.fileEnviron.BatFileEnviron.add_comment">
1195 <code class="descname">add_comment</code><span class="sig-paren">(</span><em>comment</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#BatFileEnviron.add_comment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.BatFileEnviron.add_comment" title="Permalink to this definition">¶</a></dt>
1196 <dd><p>Add a comment in the shell file</p>
1197 <table class="docutils field-list" frame="void" rules="none">
1198 <col class="field-name" />
1199 <col class="field-body" />
1200 <tbody valign="top">
1201 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>comment</em>) – the comment to add</td>
1202 </tr>
1203 </tbody>
1204 </table>
1205 </dd></dl>
1206
1207 <dl class="method">
1208 <dt id="src.fileEnviron.BatFileEnviron.command_value">
1209 <code class="descname">command_value</code><span class="sig-paren">(</span><em>key</em>, <em>command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#BatFileEnviron.command_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.BatFileEnviron.command_value" title="Permalink to this definition">¶</a></dt>
1210 <dd><p>Get the value given by the system command “command”
1211 and put it in the environment variable key.
1212 Has to be overwritten in the derived classes
1213 This can be seen as a virtual method</p>
1214 <table class="docutils field-list" frame="void" rules="none">
1215 <col class="field-name" />
1216 <col class="field-body" />
1217 <tbody valign="top">
1218 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1219 <li><strong>str</strong> (<em>command</em>) – the environment variable</li>
1220 <li><strong>str</strong> – the command to execute</li>
1221 </ul>
1222 </td>
1223 </tr>
1224 </tbody>
1225 </table>
1226 </dd></dl>
1227
1228 <dl class="method">
1229 <dt id="src.fileEnviron.BatFileEnviron.finish">
1230 <code class="descname">finish</code><span class="sig-paren">(</span><em>required=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#BatFileEnviron.finish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.BatFileEnviron.finish" title="Permalink to this definition">¶</a></dt>
1231 <dd><p>Add a final instruction in the out file (in case of file generation)
1232 In the particular windows case, do nothing</p>
1233 <table class="docutils field-list" frame="void" rules="none">
1234 <col class="field-name" />
1235 <col class="field-body" />
1236 <tbody valign="top">
1237 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bool</strong> (<em>required</em>) – Do nothing if required is False</td>
1238 </tr>
1239 </tbody>
1240 </table>
1241 </dd></dl>
1242
1243 <dl class="method">
1244 <dt id="src.fileEnviron.BatFileEnviron.get">
1245 <code class="descname">get</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#BatFileEnviron.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.BatFileEnviron.get" title="Permalink to this definition">¶</a></dt>
1246 <dd><p>Get the value of the environment variable “key”</p>
1247 <table class="docutils field-list" frame="void" rules="none">
1248 <col class="field-name" />
1249 <col class="field-body" />
1250 <tbody valign="top">
1251 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable</td>
1252 </tr>
1253 </tbody>
1254 </table>
1255 </dd></dl>
1256
1257 <dl class="method">
1258 <dt id="src.fileEnviron.BatFileEnviron.set">
1259 <code class="descname">set</code><span class="sig-paren">(</span><em>key</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#BatFileEnviron.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.BatFileEnviron.set" title="Permalink to this definition">¶</a></dt>
1260 <dd><p>Set the environment variable “key” to value “value”</p>
1261 <table class="docutils field-list" frame="void" rules="none">
1262 <col class="field-name" />
1263 <col class="field-body" />
1264 <tbody valign="top">
1265 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1266 <li><strong>str</strong> (<em>value</em>) – the environment variable to set</li>
1267 <li><strong>str</strong> – the value</li>
1268 </ul>
1269 </td>
1270 </tr>
1271 </tbody>
1272 </table>
1273 </dd></dl>
1274
1275 </dd></dl>
1276
1277 <dl class="class">
1278 <dt id="src.fileEnviron.ContextFileEnviron">
1279 <em class="property">class </em><code class="descclassname">src.fileEnviron.</code><code class="descname">ContextFileEnviron</code><span class="sig-paren">(</span><em>output</em>, <em>environ=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ContextFileEnviron"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ContextFileEnviron" title="Permalink to this definition">¶</a></dt>
1280 <dd><p>Bases: <a class="reference internal" href="#src.fileEnviron.FileEnviron" title="src.fileEnviron.FileEnviron"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.fileEnviron.FileEnviron</span></code></a></p>
1281 <p>Class for a salome context configuration file.</p>
1282 <dl class="method">
1283 <dt id="src.fileEnviron.ContextFileEnviron.add_echo">
1284 <code class="descname">add_echo</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ContextFileEnviron.add_echo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ContextFileEnviron.add_echo" title="Permalink to this definition">¶</a></dt>
1285 <dd><p>Add a comment</p>
1286 <table class="docutils field-list" frame="void" rules="none">
1287 <col class="field-name" />
1288 <col class="field-body" />
1289 <tbody valign="top">
1290 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>text</em>) – the comment to add</td>
1291 </tr>
1292 </tbody>
1293 </table>
1294 </dd></dl>
1295
1296 <dl class="method">
1297 <dt id="src.fileEnviron.ContextFileEnviron.add_warning">
1298 <code class="descname">add_warning</code><span class="sig-paren">(</span><em>warning</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ContextFileEnviron.add_warning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ContextFileEnviron.add_warning" title="Permalink to this definition">¶</a></dt>
1299 <dd><p>Add a warning</p>
1300 <table class="docutils field-list" frame="void" rules="none">
1301 <col class="field-name" />
1302 <col class="field-body" />
1303 <tbody valign="top">
1304 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>text</em>) – the warning to add</td>
1305 </tr>
1306 </tbody>
1307 </table>
1308 </dd></dl>
1309
1310 <dl class="method">
1311 <dt id="src.fileEnviron.ContextFileEnviron.append_value">
1312 <code class="descname">append_value</code><span class="sig-paren">(</span><em>key</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ContextFileEnviron.append_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ContextFileEnviron.append_value" title="Permalink to this definition">¶</a></dt>
1313 <dd><p>append value to key using sep</p>
1314 <table class="docutils field-list" frame="void" rules="none">
1315 <col class="field-name" />
1316 <col class="field-body" />
1317 <tbody valign="top">
1318 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1319 <li><strong>str</strong> (<em>sep</em>) – the environment variable to append</li>
1320 <li><strong>str</strong> – the value to append to key</li>
1321 <li><strong>str</strong> – the separator string</li>
1322 </ul>
1323 </td>
1324 </tr>
1325 </tbody>
1326 </table>
1327 </dd></dl>
1328
1329 <dl class="method">
1330 <dt id="src.fileEnviron.ContextFileEnviron.command_value">
1331 <code class="descname">command_value</code><span class="sig-paren">(</span><em>key</em>, <em>command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ContextFileEnviron.command_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ContextFileEnviron.command_value" title="Permalink to this definition">¶</a></dt>
1332 <dd><p>Get the value given by the system command “command”
1333 and put it in the environment variable key.
1334 Has to be overwritten in the derived classes
1335 This can be seen as a virtual method</p>
1336 <table class="docutils field-list" frame="void" rules="none">
1337 <col class="field-name" />
1338 <col class="field-body" />
1339 <tbody valign="top">
1340 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1341 <li><strong>str</strong> (<em>command</em>) – the environment variable</li>
1342 <li><strong>str</strong> – the command to execute</li>
1343 </ul>
1344 </td>
1345 </tr>
1346 </tbody>
1347 </table>
1348 </dd></dl>
1349
1350 <dl class="method">
1351 <dt id="src.fileEnviron.ContextFileEnviron.finish">
1352 <code class="descname">finish</code><span class="sig-paren">(</span><em>required=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ContextFileEnviron.finish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ContextFileEnviron.finish" title="Permalink to this definition">¶</a></dt>
1353 <dd><p>Add a final instruction in the out file (in case of file generation)</p>
1354 <table class="docutils field-list" frame="void" rules="none">
1355 <col class="field-name" />
1356 <col class="field-body" />
1357 <tbody valign="top">
1358 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bool</strong> (<em>required</em>) – Do nothing if required is False</td>
1359 </tr>
1360 </tbody>
1361 </table>
1362 </dd></dl>
1363
1364 <dl class="method">
1365 <dt id="src.fileEnviron.ContextFileEnviron.get">
1366 <code class="descname">get</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ContextFileEnviron.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ContextFileEnviron.get" title="Permalink to this definition">¶</a></dt>
1367 <dd><p>Get the value of the environment variable “key”</p>
1368 <table class="docutils field-list" frame="void" rules="none">
1369 <col class="field-name" />
1370 <col class="field-body" />
1371 <tbody valign="top">
1372 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable</td>
1373 </tr>
1374 </tbody>
1375 </table>
1376 </dd></dl>
1377
1378 <dl class="method">
1379 <dt id="src.fileEnviron.ContextFileEnviron.prepend_value">
1380 <code class="descname">prepend_value</code><span class="sig-paren">(</span><em>key</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ContextFileEnviron.prepend_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ContextFileEnviron.prepend_value" title="Permalink to this definition">¶</a></dt>
1381 <dd><p>prepend value to key using sep</p>
1382 <table class="docutils field-list" frame="void" rules="none">
1383 <col class="field-name" />
1384 <col class="field-body" />
1385 <tbody valign="top">
1386 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1387 <li><strong>str</strong> (<em>sep</em>) – the environment variable to prepend</li>
1388 <li><strong>str</strong> – the value to prepend to key</li>
1389 <li><strong>str</strong> – the separator string</li>
1390 </ul>
1391 </td>
1392 </tr>
1393 </tbody>
1394 </table>
1395 </dd></dl>
1396
1397 <dl class="method">
1398 <dt id="src.fileEnviron.ContextFileEnviron.set">
1399 <code class="descname">set</code><span class="sig-paren">(</span><em>key</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ContextFileEnviron.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ContextFileEnviron.set" title="Permalink to this definition">¶</a></dt>
1400 <dd><p>Set the environment variable “key” to value “value”</p>
1401 <table class="docutils field-list" frame="void" rules="none">
1402 <col class="field-name" />
1403 <col class="field-body" />
1404 <tbody valign="top">
1405 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1406 <li><strong>str</strong> (<em>value</em>) – the environment variable to set</li>
1407 <li><strong>str</strong> – the value</li>
1408 </ul>
1409 </td>
1410 </tr>
1411 </tbody>
1412 </table>
1413 </dd></dl>
1414
1415 </dd></dl>
1416
1417 <dl class="class">
1418 <dt id="src.fileEnviron.FileEnviron">
1419 <em class="property">class </em><code class="descclassname">src.fileEnviron.</code><code class="descname">FileEnviron</code><span class="sig-paren">(</span><em>output</em>, <em>environ=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron" title="Permalink to this definition">¶</a></dt>
1420 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
1421 <p>Base class for shell environment</p>
1422 <dl class="method">
1423 <dt id="src.fileEnviron.FileEnviron.add_comment">
1424 <code class="descname">add_comment</code><span class="sig-paren">(</span><em>comment</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron.add_comment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron.add_comment" title="Permalink to this definition">¶</a></dt>
1425 <dd><p>Add a comment in the shell file</p>
1426 <table class="docutils field-list" frame="void" rules="none">
1427 <col class="field-name" />
1428 <col class="field-body" />
1429 <tbody valign="top">
1430 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>comment</em>) – the comment to add</td>
1431 </tr>
1432 </tbody>
1433 </table>
1434 </dd></dl>
1435
1436 <dl class="method">
1437 <dt id="src.fileEnviron.FileEnviron.add_echo">
1438 <code class="descname">add_echo</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron.add_echo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron.add_echo" title="Permalink to this definition">¶</a></dt>
1439 <dd><p>Add a “echo” in the shell file</p>
1440 <table class="docutils field-list" frame="void" rules="none">
1441 <col class="field-name" />
1442 <col class="field-body" />
1443 <tbody valign="top">
1444 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>text</em>) – the text to echo</td>
1445 </tr>
1446 </tbody>
1447 </table>
1448 </dd></dl>
1449
1450 <dl class="method">
1451 <dt id="src.fileEnviron.FileEnviron.add_line">
1452 <code class="descname">add_line</code><span class="sig-paren">(</span><em>number</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron.add_line"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron.add_line" title="Permalink to this definition">¶</a></dt>
1453 <dd><p>Add some empty lines in the shell file</p>
1454 <table class="docutils field-list" frame="void" rules="none">
1455 <col class="field-name" />
1456 <col class="field-body" />
1457 <tbody valign="top">
1458 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>int</strong> (<em>number</em>) – the number of lines to add</td>
1459 </tr>
1460 </tbody>
1461 </table>
1462 </dd></dl>
1463
1464 <dl class="method">
1465 <dt id="src.fileEnviron.FileEnviron.add_warning">
1466 <code class="descname">add_warning</code><span class="sig-paren">(</span><em>warning</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron.add_warning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron.add_warning" title="Permalink to this definition">¶</a></dt>
1467 <dd><p>Add a warning “echo” in the shell file</p>
1468 <table class="docutils field-list" frame="void" rules="none">
1469 <col class="field-name" />
1470 <col class="field-body" />
1471 <tbody valign="top">
1472 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>warning</em>) – the text to echo</td>
1473 </tr>
1474 </tbody>
1475 </table>
1476 </dd></dl>
1477
1478 <dl class="method">
1479 <dt id="src.fileEnviron.FileEnviron.append">
1480 <code class="descname">append</code><span class="sig-paren">(</span><em>key</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron.append"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron.append" title="Permalink to this definition">¶</a></dt>
1481 <dd><p>Same as append_value but the value argument can be a list</p>
1482 <table class="docutils field-list" frame="void" rules="none">
1483 <col class="field-name" />
1484 <col class="field-body" />
1485 <tbody valign="top">
1486 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1487 <li><strong>str</strong> (<em>sep</em>) – the environment variable to append</li>
1488 <li><strong>str</strong><strong> or </strong><strong>list</strong> (<em>value</em>) – the value(s) to append to key</li>
1489 <li><strong>str</strong> – the separator string</li>
1490 </ul>
1491 </td>
1492 </tr>
1493 </tbody>
1494 </table>
1495 </dd></dl>
1496
1497 <dl class="method">
1498 <dt id="src.fileEnviron.FileEnviron.append_value">
1499 <code class="descname">append_value</code><span class="sig-paren">(</span><em>key</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron.append_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron.append_value" title="Permalink to this definition">¶</a></dt>
1500 <dd><p>append value to key using sep</p>
1501 <table class="docutils field-list" frame="void" rules="none">
1502 <col class="field-name" />
1503 <col class="field-body" />
1504 <tbody valign="top">
1505 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1506 <li><strong>str</strong> (<em>sep</em>) – the environment variable to append</li>
1507 <li><strong>str</strong> – the value to append to key</li>
1508 <li><strong>str</strong> – the separator string</li>
1509 </ul>
1510 </td>
1511 </tr>
1512 </tbody>
1513 </table>
1514 </dd></dl>
1515
1516 <dl class="method">
1517 <dt id="src.fileEnviron.FileEnviron.command_value">
1518 <code class="descname">command_value</code><span class="sig-paren">(</span><em>key</em>, <em>command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron.command_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron.command_value" title="Permalink to this definition">¶</a></dt>
1519 <dd><p>Get the value given by the system command “command”
1520 and put it in the environment variable key.
1521 Has to be overwritten in the derived classes
1522 This can be seen as a virtual method</p>
1523 <table class="docutils field-list" frame="void" rules="none">
1524 <col class="field-name" />
1525 <col class="field-body" />
1526 <tbody valign="top">
1527 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1528 <li><strong>str</strong> (<em>command</em>) – the environment variable</li>
1529 <li><strong>str</strong> – the command to execute</li>
1530 </ul>
1531 </td>
1532 </tr>
1533 </tbody>
1534 </table>
1535 </dd></dl>
1536
1537 <dl class="method">
1538 <dt id="src.fileEnviron.FileEnviron.finish">
1539 <code class="descname">finish</code><span class="sig-paren">(</span><em>required=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron.finish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron.finish" title="Permalink to this definition">¶</a></dt>
1540 <dd><p>Add a final instruction in the out file (in case of file generation)</p>
1541 <table class="docutils field-list" frame="void" rules="none">
1542 <col class="field-name" />
1543 <col class="field-body" />
1544 <tbody valign="top">
1545 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bool</strong> (<em>required</em>) – Do nothing if required is False</td>
1546 </tr>
1547 </tbody>
1548 </table>
1549 </dd></dl>
1550
1551 <dl class="method">
1552 <dt id="src.fileEnviron.FileEnviron.get">
1553 <code class="descname">get</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron.get" title="Permalink to this definition">¶</a></dt>
1554 <dd><p>Get the value of the environment variable “key”</p>
1555 <table class="docutils field-list" frame="void" rules="none">
1556 <col class="field-name" />
1557 <col class="field-body" />
1558 <tbody valign="top">
1559 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable</td>
1560 </tr>
1561 </tbody>
1562 </table>
1563 </dd></dl>
1564
1565 <dl class="method">
1566 <dt id="src.fileEnviron.FileEnviron.is_defined">
1567 <code class="descname">is_defined</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron.is_defined"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron.is_defined" title="Permalink to this definition">¶</a></dt>
1568 <dd><p>Check if the key exists in the environment</p>
1569 <table class="docutils field-list" frame="void" rules="none">
1570 <col class="field-name" />
1571 <col class="field-body" />
1572 <tbody valign="top">
1573 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable to check</td>
1574 </tr>
1575 </tbody>
1576 </table>
1577 </dd></dl>
1578
1579 <dl class="method">
1580 <dt id="src.fileEnviron.FileEnviron.prepend">
1581 <code class="descname">prepend</code><span class="sig-paren">(</span><em>key</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron.prepend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron.prepend" title="Permalink to this definition">¶</a></dt>
1582 <dd><p>Same as prepend_value but the value argument can be a list</p>
1583 <table class="docutils field-list" frame="void" rules="none">
1584 <col class="field-name" />
1585 <col class="field-body" />
1586 <tbody valign="top">
1587 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1588 <li><strong>str</strong> (<em>sep</em>) – the environment variable to prepend</li>
1589 <li><strong>str</strong><strong> or </strong><strong>list</strong> (<em>value</em>) – the value(s) to prepend to key</li>
1590 <li><strong>str</strong> – the separator string</li>
1591 </ul>
1592 </td>
1593 </tr>
1594 </tbody>
1595 </table>
1596 </dd></dl>
1597
1598 <dl class="method">
1599 <dt id="src.fileEnviron.FileEnviron.prepend_value">
1600 <code class="descname">prepend_value</code><span class="sig-paren">(</span><em>key</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron.prepend_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron.prepend_value" title="Permalink to this definition">¶</a></dt>
1601 <dd><p>prepend value to key using sep</p>
1602 <table class="docutils field-list" frame="void" rules="none">
1603 <col class="field-name" />
1604 <col class="field-body" />
1605 <tbody valign="top">
1606 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1607 <li><strong>str</strong> (<em>sep</em>) – the environment variable to prepend</li>
1608 <li><strong>str</strong> – the value to prepend to key</li>
1609 <li><strong>str</strong> – the separator string</li>
1610 </ul>
1611 </td>
1612 </tr>
1613 </tbody>
1614 </table>
1615 </dd></dl>
1616
1617 <dl class="method">
1618 <dt id="src.fileEnviron.FileEnviron.set">
1619 <code class="descname">set</code><span class="sig-paren">(</span><em>key</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#FileEnviron.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.FileEnviron.set" title="Permalink to this definition">¶</a></dt>
1620 <dd><p>Set the environment variable ‘key’ to value ‘value’</p>
1621 <table class="docutils field-list" frame="void" rules="none">
1622 <col class="field-name" />
1623 <col class="field-body" />
1624 <tbody valign="top">
1625 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1626 <li><strong>str</strong> (<em>value</em>) – the environment variable to set</li>
1627 <li><strong>str</strong> – the value</li>
1628 </ul>
1629 </td>
1630 </tr>
1631 </tbody>
1632 </table>
1633 </dd></dl>
1634
1635 </dd></dl>
1636
1637 <dl class="class">
1638 <dt id="src.fileEnviron.LauncherFileEnviron">
1639 <em class="property">class </em><code class="descclassname">src.fileEnviron.</code><code class="descname">LauncherFileEnviron</code><span class="sig-paren">(</span><em>output</em>, <em>environ=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron" title="Permalink to this definition">¶</a></dt>
1640 <dd><p>Class to generate a launcher file script
1641 (in python syntax) SalomeContext API</p>
1642 <dl class="method">
1643 <dt id="src.fileEnviron.LauncherFileEnviron.add">
1644 <code class="descname">add</code><span class="sig-paren">(</span><em>key</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron.add" title="Permalink to this definition">¶</a></dt>
1645 <dd><p>prepend value to key using sep</p>
1646 <table class="docutils field-list" frame="void" rules="none">
1647 <col class="field-name" />
1648 <col class="field-body" />
1649 <tbody valign="top">
1650 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1651 <li><strong>str</strong> (<em>value</em>) – the environment variable to prepend</li>
1652 <li><strong>str</strong> – the value to prepend to key</li>
1653 </ul>
1654 </td>
1655 </tr>
1656 </tbody>
1657 </table>
1658 </dd></dl>
1659
1660 <dl class="method">
1661 <dt id="src.fileEnviron.LauncherFileEnviron.add_comment">
1662 <code class="descname">add_comment</code><span class="sig-paren">(</span><em>comment</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron.add_comment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron.add_comment" title="Permalink to this definition">¶</a></dt>
1663 <dd></dd></dl>
1664
1665 <dl class="method">
1666 <dt id="src.fileEnviron.LauncherFileEnviron.add_echo">
1667 <code class="descname">add_echo</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron.add_echo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron.add_echo" title="Permalink to this definition">¶</a></dt>
1668 <dd><p>Add a comment</p>
1669 <table class="docutils field-list" frame="void" rules="none">
1670 <col class="field-name" />
1671 <col class="field-body" />
1672 <tbody valign="top">
1673 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>text</em>) – the comment to add</td>
1674 </tr>
1675 </tbody>
1676 </table>
1677 </dd></dl>
1678
1679 <dl class="method">
1680 <dt id="src.fileEnviron.LauncherFileEnviron.add_line">
1681 <code class="descname">add_line</code><span class="sig-paren">(</span><em>number</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron.add_line"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron.add_line" title="Permalink to this definition">¶</a></dt>
1682 <dd><p>Add some empty lines in the launcher file</p>
1683 <table class="docutils field-list" frame="void" rules="none">
1684 <col class="field-name" />
1685 <col class="field-body" />
1686 <tbody valign="top">
1687 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>int</strong> (<em>number</em>) – the number of lines to add</td>
1688 </tr>
1689 </tbody>
1690 </table>
1691 </dd></dl>
1692
1693 <dl class="method">
1694 <dt id="src.fileEnviron.LauncherFileEnviron.add_warning">
1695 <code class="descname">add_warning</code><span class="sig-paren">(</span><em>warning</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron.add_warning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron.add_warning" title="Permalink to this definition">¶</a></dt>
1696 <dd><p>Add a warning</p>
1697 <table class="docutils field-list" frame="void" rules="none">
1698 <col class="field-name" />
1699 <col class="field-body" />
1700 <tbody valign="top">
1701 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>text</em>) – the warning to add</td>
1702 </tr>
1703 </tbody>
1704 </table>
1705 </dd></dl>
1706
1707 <dl class="method">
1708 <dt id="src.fileEnviron.LauncherFileEnviron.append">
1709 <code class="descname">append</code><span class="sig-paren">(</span><em>key</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron.append"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron.append" title="Permalink to this definition">¶</a></dt>
1710 <dd><p>Same as append_value but the value argument can be a list</p>
1711 <table class="docutils field-list" frame="void" rules="none">
1712 <col class="field-name" />
1713 <col class="field-body" />
1714 <tbody valign="top">
1715 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1716 <li><strong>str</strong> (<em>sep</em>) – the environment variable to append</li>
1717 <li><strong>str</strong><strong> or </strong><strong>list</strong> (<em>value</em>) – the value(s) to append to key</li>
1718 <li><strong>str</strong> – the separator string</li>
1719 </ul>
1720 </td>
1721 </tr>
1722 </tbody>
1723 </table>
1724 </dd></dl>
1725
1726 <dl class="method">
1727 <dt id="src.fileEnviron.LauncherFileEnviron.append_value">
1728 <code class="descname">append_value</code><span class="sig-paren">(</span><em>key</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron.append_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron.append_value" title="Permalink to this definition">¶</a></dt>
1729 <dd><p>append value to key using sep</p>
1730 <table class="docutils field-list" frame="void" rules="none">
1731 <col class="field-name" />
1732 <col class="field-body" />
1733 <tbody valign="top">
1734 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1735 <li><strong>str</strong> (<em>sep</em>) – the environment variable to append</li>
1736 <li><strong>str</strong> – the value to append to key</li>
1737 <li><strong>str</strong> – the separator string</li>
1738 </ul>
1739 </td>
1740 </tr>
1741 </tbody>
1742 </table>
1743 </dd></dl>
1744
1745 <dl class="method">
1746 <dt id="src.fileEnviron.LauncherFileEnviron.change_to_launcher">
1747 <code class="descname">change_to_launcher</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron.change_to_launcher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron.change_to_launcher" title="Permalink to this definition">¶</a></dt>
1748 <dd></dd></dl>
1749
1750 <dl class="method">
1751 <dt id="src.fileEnviron.LauncherFileEnviron.command_value">
1752 <code class="descname">command_value</code><span class="sig-paren">(</span><em>key</em>, <em>command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron.command_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron.command_value" title="Permalink to this definition">¶</a></dt>
1753 <dd><p>Get the value given by the system command “command”
1754 and put it in the environment variable key.</p>
1755 <table class="docutils field-list" frame="void" rules="none">
1756 <col class="field-name" />
1757 <col class="field-body" />
1758 <tbody valign="top">
1759 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1760 <li><strong>str</strong> (<em>command</em>) – the environment variable</li>
1761 <li><strong>str</strong> – the command to execute</li>
1762 </ul>
1763 </td>
1764 </tr>
1765 </tbody>
1766 </table>
1767 </dd></dl>
1768
1769 <dl class="method">
1770 <dt id="src.fileEnviron.LauncherFileEnviron.finish">
1771 <code class="descname">finish</code><span class="sig-paren">(</span><em>required=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron.finish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron.finish" title="Permalink to this definition">¶</a></dt>
1772 <dd><p>Add a final instruction in the out file (in case of file generation)
1773 In the particular launcher case, do nothing</p>
1774 <table class="docutils field-list" frame="void" rules="none">
1775 <col class="field-name" />
1776 <col class="field-body" />
1777 <tbody valign="top">
1778 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bool</strong> (<em>required</em>) – Do nothing if required is False</td>
1779 </tr>
1780 </tbody>
1781 </table>
1782 </dd></dl>
1783
1784 <dl class="method">
1785 <dt id="src.fileEnviron.LauncherFileEnviron.get">
1786 <code class="descname">get</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron.get" title="Permalink to this definition">¶</a></dt>
1787 <dd><p>Get the value of the environment variable “key”</p>
1788 <table class="docutils field-list" frame="void" rules="none">
1789 <col class="field-name" />
1790 <col class="field-body" />
1791 <tbody valign="top">
1792 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable</td>
1793 </tr>
1794 </tbody>
1795 </table>
1796 </dd></dl>
1797
1798 <dl class="method">
1799 <dt id="src.fileEnviron.LauncherFileEnviron.is_defined">
1800 <code class="descname">is_defined</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron.is_defined"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron.is_defined" title="Permalink to this definition">¶</a></dt>
1801 <dd><p>Check if the key exists in the environment</p>
1802 <table class="docutils field-list" frame="void" rules="none">
1803 <col class="field-name" />
1804 <col class="field-body" />
1805 <tbody valign="top">
1806 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable to check</td>
1807 </tr>
1808 </tbody>
1809 </table>
1810 </dd></dl>
1811
1812 <dl class="method">
1813 <dt id="src.fileEnviron.LauncherFileEnviron.prepend">
1814 <code class="descname">prepend</code><span class="sig-paren">(</span><em>key</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron.prepend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron.prepend" title="Permalink to this definition">¶</a></dt>
1815 <dd><p>Same as prepend_value but the value argument can be a list</p>
1816 <table class="docutils field-list" frame="void" rules="none">
1817 <col class="field-name" />
1818 <col class="field-body" />
1819 <tbody valign="top">
1820 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1821 <li><strong>str</strong> (<em>sep</em>) – the environment variable to prepend</li>
1822 <li><strong>str</strong><strong> or </strong><strong>list</strong> (<em>value</em>) – the value(s) to prepend to key</li>
1823 <li><strong>str</strong> – the separator string</li>
1824 </ul>
1825 </td>
1826 </tr>
1827 </tbody>
1828 </table>
1829 </dd></dl>
1830
1831 <dl class="method">
1832 <dt id="src.fileEnviron.LauncherFileEnviron.prepend_value">
1833 <code class="descname">prepend_value</code><span class="sig-paren">(</span><em>key</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron.prepend_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron.prepend_value" title="Permalink to this definition">¶</a></dt>
1834 <dd><p>prepend value to key using sep</p>
1835 <table class="docutils field-list" frame="void" rules="none">
1836 <col class="field-name" />
1837 <col class="field-body" />
1838 <tbody valign="top">
1839 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1840 <li><strong>str</strong> (<em>sep</em>) – the environment variable to prepend</li>
1841 <li><strong>str</strong> – the value to prepend to key</li>
1842 <li><strong>str</strong> – the separator string</li>
1843 </ul>
1844 </td>
1845 </tr>
1846 </tbody>
1847 </table>
1848 </dd></dl>
1849
1850 <dl class="method">
1851 <dt id="src.fileEnviron.LauncherFileEnviron.set">
1852 <code class="descname">set</code><span class="sig-paren">(</span><em>key</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#LauncherFileEnviron.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.LauncherFileEnviron.set" title="Permalink to this definition">¶</a></dt>
1853 <dd><p>Set the environment variable “key” to value “value”</p>
1854 <table class="docutils field-list" frame="void" rules="none">
1855 <col class="field-name" />
1856 <col class="field-body" />
1857 <tbody valign="top">
1858 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1859 <li><strong>str</strong> (<em>value</em>) – the environment variable to set</li>
1860 <li><strong>str</strong> – the value</li>
1861 </ul>
1862 </td>
1863 </tr>
1864 </tbody>
1865 </table>
1866 </dd></dl>
1867
1868 </dd></dl>
1869
1870 <dl class="class">
1871 <dt id="src.fileEnviron.ScreenEnviron">
1872 <em class="property">class </em><code class="descclassname">src.fileEnviron.</code><code class="descname">ScreenEnviron</code><span class="sig-paren">(</span><em>output</em>, <em>environ=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron" title="Permalink to this definition">¶</a></dt>
1873 <dd><p>Bases: <a class="reference internal" href="#src.fileEnviron.FileEnviron" title="src.fileEnviron.FileEnviron"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.fileEnviron.FileEnviron</span></code></a></p>
1874 <dl class="method">
1875 <dt id="src.fileEnviron.ScreenEnviron.add_comment">
1876 <code class="descname">add_comment</code><span class="sig-paren">(</span><em>comment</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.add_comment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.add_comment" title="Permalink to this definition">¶</a></dt>
1877 <dd><p>Add a comment in the shell file</p>
1878 <table class="docutils field-list" frame="void" rules="none">
1879 <col class="field-name" />
1880 <col class="field-body" />
1881 <tbody valign="top">
1882 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>comment</em>) – the comment to add</td>
1883 </tr>
1884 </tbody>
1885 </table>
1886 </dd></dl>
1887
1888 <dl class="method">
1889 <dt id="src.fileEnviron.ScreenEnviron.add_echo">
1890 <code class="descname">add_echo</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.add_echo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.add_echo" title="Permalink to this definition">¶</a></dt>
1891 <dd><p>Add a “echo” in the shell file</p>
1892 <table class="docutils field-list" frame="void" rules="none">
1893 <col class="field-name" />
1894 <col class="field-body" />
1895 <tbody valign="top">
1896 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>text</em>) – the text to echo</td>
1897 </tr>
1898 </tbody>
1899 </table>
1900 </dd></dl>
1901
1902 <dl class="method">
1903 <dt id="src.fileEnviron.ScreenEnviron.add_line">
1904 <code class="descname">add_line</code><span class="sig-paren">(</span><em>number</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.add_line"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.add_line" title="Permalink to this definition">¶</a></dt>
1905 <dd><p>Add some empty lines in the shell file</p>
1906 <table class="docutils field-list" frame="void" rules="none">
1907 <col class="field-name" />
1908 <col class="field-body" />
1909 <tbody valign="top">
1910 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>int</strong> (<em>number</em>) – the number of lines to add</td>
1911 </tr>
1912 </tbody>
1913 </table>
1914 </dd></dl>
1915
1916 <dl class="method">
1917 <dt id="src.fileEnviron.ScreenEnviron.add_warning">
1918 <code class="descname">add_warning</code><span class="sig-paren">(</span><em>warning</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.add_warning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.add_warning" title="Permalink to this definition">¶</a></dt>
1919 <dd><p>Add a warning “echo” in the shell file</p>
1920 <table class="docutils field-list" frame="void" rules="none">
1921 <col class="field-name" />
1922 <col class="field-body" />
1923 <tbody valign="top">
1924 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>warning</em>) – the text to echo</td>
1925 </tr>
1926 </tbody>
1927 </table>
1928 </dd></dl>
1929
1930 <dl class="method">
1931 <dt id="src.fileEnviron.ScreenEnviron.append">
1932 <code class="descname">append</code><span class="sig-paren">(</span><em>name</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.append"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.append" title="Permalink to this definition">¶</a></dt>
1933 <dd><p>Same as append_value but the value argument can be a list</p>
1934 <table class="docutils field-list" frame="void" rules="none">
1935 <col class="field-name" />
1936 <col class="field-body" />
1937 <tbody valign="top">
1938 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1939 <li><strong>str</strong> (<em>sep</em>) – the environment variable to append</li>
1940 <li><strong>str</strong><strong> or </strong><strong>list</strong> (<em>value</em>) – the value(s) to append to key</li>
1941 <li><strong>str</strong> – the separator string</li>
1942 </ul>
1943 </td>
1944 </tr>
1945 </tbody>
1946 </table>
1947 </dd></dl>
1948
1949 <dl class="method">
1950 <dt id="src.fileEnviron.ScreenEnviron.command_value">
1951 <code class="descname">command_value</code><span class="sig-paren">(</span><em>key</em>, <em>command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.command_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.command_value" title="Permalink to this definition">¶</a></dt>
1952 <dd><p>Get the value given by the system command “command”
1953 and put it in the environment variable key.
1954 Has to be overwritten in the derived classes
1955 This can be seen as a virtual method</p>
1956 <table class="docutils field-list" frame="void" rules="none">
1957 <col class="field-name" />
1958 <col class="field-body" />
1959 <tbody valign="top">
1960 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1961 <li><strong>str</strong> (<em>command</em>) – the environment variable</li>
1962 <li><strong>str</strong> – the command to execute</li>
1963 </ul>
1964 </td>
1965 </tr>
1966 </tbody>
1967 </table>
1968 </dd></dl>
1969
1970 <dl class="method">
1971 <dt id="src.fileEnviron.ScreenEnviron.get">
1972 <code class="descname">get</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.get" title="Permalink to this definition">¶</a></dt>
1973 <dd><p>Get the value of the environment variable “key”</p>
1974 <table class="docutils field-list" frame="void" rules="none">
1975 <col class="field-name" />
1976 <col class="field-body" />
1977 <tbody valign="top">
1978 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable</td>
1979 </tr>
1980 </tbody>
1981 </table>
1982 </dd></dl>
1983
1984 <dl class="method">
1985 <dt id="src.fileEnviron.ScreenEnviron.is_defined">
1986 <code class="descname">is_defined</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.is_defined"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.is_defined" title="Permalink to this definition">¶</a></dt>
1987 <dd><p>Check if the key exists in the environment</p>
1988 <table class="docutils field-list" frame="void" rules="none">
1989 <col class="field-name" />
1990 <col class="field-body" />
1991 <tbody valign="top">
1992 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>key</em>) – the environment variable to check</td>
1993 </tr>
1994 </tbody>
1995 </table>
1996 </dd></dl>
1997
1998 <dl class="method">
1999 <dt id="src.fileEnviron.ScreenEnviron.prepend">
2000 <code class="descname">prepend</code><span class="sig-paren">(</span><em>name</em>, <em>value</em>, <em>sep=':'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.prepend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.prepend" title="Permalink to this definition">¶</a></dt>
2001 <dd><p>Same as prepend_value but the value argument can be a list</p>
2002 <table class="docutils field-list" frame="void" rules="none">
2003 <col class="field-name" />
2004 <col class="field-body" />
2005 <tbody valign="top">
2006 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2007 <li><strong>str</strong> (<em>sep</em>) – the environment variable to prepend</li>
2008 <li><strong>str</strong><strong> or </strong><strong>list</strong> (<em>value</em>) – the value(s) to prepend to key</li>
2009 <li><strong>str</strong> – the separator string</li>
2010 </ul>
2011 </td>
2012 </tr>
2013 </tbody>
2014 </table>
2015 </dd></dl>
2016
2017 <dl class="method">
2018 <dt id="src.fileEnviron.ScreenEnviron.run_env_script">
2019 <code class="descname">run_env_script</code><span class="sig-paren">(</span><em>module</em>, <em>script</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.run_env_script"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.run_env_script" title="Permalink to this definition">¶</a></dt>
2020 <dd></dd></dl>
2021
2022 <dl class="method">
2023 <dt id="src.fileEnviron.ScreenEnviron.set">
2024 <code class="descname">set</code><span class="sig-paren">(</span><em>name</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.set" title="Permalink to this definition">¶</a></dt>
2025 <dd><p>Set the environment variable ‘key’ to value ‘value’</p>
2026 <table class="docutils field-list" frame="void" rules="none">
2027 <col class="field-name" />
2028 <col class="field-body" />
2029 <tbody valign="top">
2030 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2031 <li><strong>str</strong> (<em>value</em>) – the environment variable to set</li>
2032 <li><strong>str</strong> – the value</li>
2033 </ul>
2034 </td>
2035 </tr>
2036 </tbody>
2037 </table>
2038 </dd></dl>
2039
2040 <dl class="method">
2041 <dt id="src.fileEnviron.ScreenEnviron.write">
2042 <code class="descname">write</code><span class="sig-paren">(</span><em>command</em>, <em>name</em>, <em>value</em>, <em>sign='='</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#ScreenEnviron.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.ScreenEnviron.write" title="Permalink to this definition">¶</a></dt>
2043 <dd></dd></dl>
2044
2045 </dd></dl>
2046
2047 <dl class="function">
2048 <dt id="src.fileEnviron.get_file_environ">
2049 <code class="descclassname">src.fileEnviron.</code><code class="descname">get_file_environ</code><span class="sig-paren">(</span><em>output</em>, <em>shell</em>, <em>environ=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#get_file_environ"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.get_file_environ" title="Permalink to this definition">¶</a></dt>
2050 <dd><p>Instantiate correct FileEnvironment sub-class.</p>
2051 <table class="docutils field-list" frame="void" rules="none">
2052 <col class="field-name" />
2053 <col class="field-body" />
2054 <tbody valign="top">
2055 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2056 <li><strong>file</strong> (<em>output</em>) – the output file stream.</li>
2057 <li><strong>str</strong> (<em>shell</em>) – the type of shell syntax to use.</li>
2058 <li><strong>dict</strong> (<em>environ</em>) – a potential additional environment.</li>
2059 </ul>
2060 </td>
2061 </tr>
2062 </tbody>
2063 </table>
2064 </dd></dl>
2065
2066 <dl class="function">
2067 <dt id="src.fileEnviron.special_path_separator">
2068 <code class="descclassname">src.fileEnviron.</code><code class="descname">special_path_separator</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fileEnviron.html#special_path_separator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fileEnviron.special_path_separator" title="Permalink to this definition">¶</a></dt>
2069 <dd><p>TCLLIBPATH, TKLIBPATH, PV_PLUGIN_PATH environments variables need
2070 some exotic path separator.
2071 This function gives the separator regarding the name of the variable
2072 to append or prepend.</p>
2073 <table class="docutils field-list" frame="void" rules="none">
2074 <col class="field-name" />
2075 <col class="field-body" />
2076 <tbody valign="top">
2077 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>name</em>) – The name of the variable to find the separator</td>
2078 </tr>
2079 </tbody>
2080 </table>
2081 </dd></dl>
2082
2083 </div>
2084 <div class="section" id="module-src.fork">
2085 <span id="src-fork-module"></span><h2>src.fork module<a class="headerlink" href="#module-src.fork" title="Permalink to this headline">¶</a></h2>
2086 <dl class="function">
2087 <dt id="src.fork.batch">
2088 <code class="descclassname">src.fork.</code><code class="descname">batch</code><span class="sig-paren">(</span><em>cmd</em>, <em>logger</em>, <em>cwd</em>, <em>args=[]</em>, <em>log=None</em>, <em>delai=20</em>, <em>sommeil=1</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fork.html#batch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fork.batch" title="Permalink to this definition">¶</a></dt>
2089 <dd></dd></dl>
2090
2091 <dl class="function">
2092 <dt id="src.fork.batch_salome">
2093 <code class="descclassname">src.fork.</code><code class="descname">batch_salome</code><span class="sig-paren">(</span><em>cmd</em>, <em>logger</em>, <em>cwd</em>, <em>args</em>, <em>getTmpDir</em>, <em>pendant='SALOME_Session_Server'</em>, <em>fin='killSalome.py'</em>, <em>log=None</em>, <em>delai=20</em>, <em>sommeil=1</em>, <em>delaiapp=0</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fork.html#batch_salome"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fork.batch_salome" title="Permalink to this definition">¶</a></dt>
2094 <dd></dd></dl>
2095
2096 <dl class="function">
2097 <dt id="src.fork.launch_command">
2098 <code class="descclassname">src.fork.</code><code class="descname">launch_command</code><span class="sig-paren">(</span><em>cmd</em>, <em>logger</em>, <em>cwd</em>, <em>args=[]</em>, <em>log=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fork.html#launch_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fork.launch_command" title="Permalink to this definition">¶</a></dt>
2099 <dd></dd></dl>
2100
2101 <dl class="function">
2102 <dt id="src.fork.show_progress">
2103 <code class="descclassname">src.fork.</code><code class="descname">show_progress</code><span class="sig-paren">(</span><em>logger</em>, <em>top</em>, <em>delai</em>, <em>ss=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fork.html#show_progress"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fork.show_progress" title="Permalink to this definition">¶</a></dt>
2104 <dd><p>shortcut function to display the progression</p>
2105 <table class="docutils field-list" frame="void" rules="none">
2106 <col class="field-name" />
2107 <col class="field-body" />
2108 <tbody valign="top">
2109 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2110 <li><strong>Logger</strong> (<em>logger</em>) – The logging instance</li>
2111 <li><strong>int</strong> (<em>delai</em>) – the number to display</li>
2112 <li><strong>int</strong> – the number max</li>
2113 <li><strong>str</strong> (<em>ss</em>) – the string to display</li>
2114 </ul>
2115 </td>
2116 </tr>
2117 </tbody>
2118 </table>
2119 </dd></dl>
2120
2121 <dl class="function">
2122 <dt id="src.fork.write_back">
2123 <code class="descclassname">src.fork.</code><code class="descname">write_back</code><span class="sig-paren">(</span><em>logger</em>, <em>message</em>, <em>level</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/fork.html#write_back"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.fork.write_back" title="Permalink to this definition">¶</a></dt>
2124 <dd><p>shortcut function to write at the begin of the line</p>
2125 <table class="docutils field-list" frame="void" rules="none">
2126 <col class="field-name" />
2127 <col class="field-body" />
2128 <tbody valign="top">
2129 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2130 <li><strong>Logger</strong> (<em>logger</em>) – The logging instance</li>
2131 <li><strong>str</strong> (<em>message</em>) – the text to display</li>
2132 <li><strong>int</strong> (<em>level</em>) – the level of verbosity</li>
2133 </ul>
2134 </td>
2135 </tr>
2136 </tbody>
2137 </table>
2138 </dd></dl>
2139
2140 </div>
2141 <div class="section" id="module-src.logger">
2142 <span id="src-logger-module"></span><h2>src.logger module<a class="headerlink" href="#module-src.logger" title="Permalink to this headline">¶</a></h2>
2143 <p>Implements the classes and method relative to the logging</p>
2144 <dl class="class">
2145 <dt id="src.logger.Logger">
2146 <em class="property">class </em><code class="descclassname">src.logger.</code><code class="descname">Logger</code><span class="sig-paren">(</span><em>config</em>, <em>silent_sysstd=False</em>, <em>all_in_terminal=False</em>, <em>micro_command=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#Logger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.Logger" title="Permalink to this definition">¶</a></dt>
2147 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
2148 <p>Class to handle log mechanism.</p>
2149 <dl class="method">
2150 <dt id="src.logger.Logger.add_link">
2151 <code class="descname">add_link</code><span class="sig-paren">(</span><em>log_file_name</em>, <em>command_name</em>, <em>command_res</em>, <em>full_launched_command</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#Logger.add_link"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.Logger.add_link" title="Permalink to this definition">¶</a></dt>
2152 <dd><p>Add a link to another log file.</p>
2153 <table class="docutils field-list" frame="void" rules="none">
2154 <col class="field-name" />
2155 <col class="field-body" />
2156 <tbody valign="top">
2157 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
2158 <li><strong>str</strong> (<em>command_res</em>) – The file name of the link.</li>
2159 <li><strong>str</strong> – The name of the command linked.</li>
2160 <li><strong>str</strong> – The result of the command linked. “0” or “1”</li>
2161 </ul>
2162 </td>
2163 </tr>
2164 <tr class="field-even field"><th class="field-name" colspan="2">Parma full_launched_command str:</th></tr>
2165 <tr class="field-even field"><td>&#160;</td><td class="field-body"><p class="first last">The full lanch command
2166 (“sat command …”)</p>
2167 </td>
2168 </tr>
2169 </tbody>
2170 </table>
2171 </dd></dl>
2172
2173 <dl class="method">
2174 <dt id="src.logger.Logger.end_write">
2175 <code class="descname">end_write</code><span class="sig-paren">(</span><em>attribute</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#Logger.end_write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.Logger.end_write" title="Permalink to this definition">¶</a></dt>
2176 <dd><p>Called just after command end: Put all fields
2177 corresponding to the command end context (time).
2178 Write the log xml file on the hard drive.
2179 And display the command to launch to get the log</p>
2180 <table class="docutils field-list" frame="void" rules="none">
2181 <col class="field-name" />
2182 <col class="field-body" />
2183 <tbody valign="top">
2184 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dict</strong> (<em>attribute</em>) – the attribute to add to the node “Site”.</td>
2185 </tr>
2186 </tbody>
2187 </table>
2188 </dd></dl>
2189
2190 <dl class="method">
2191 <dt id="src.logger.Logger.error">
2192 <code class="descname">error</code><span class="sig-paren">(</span><em>message</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#Logger.error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.Logger.error" title="Permalink to this definition">¶</a></dt>
2193 <dd><p>Print an error.</p>
2194 <table class="docutils field-list" frame="void" rules="none">
2195 <col class="field-name" />
2196 <col class="field-body" />
2197 <tbody valign="top">
2198 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>message</em>) – The message to print.</td>
2199 </tr>
2200 </tbody>
2201 </table>
2202 </dd></dl>
2203
2204 <dl class="method">
2205 <dt id="src.logger.Logger.flush">
2206 <code class="descname">flush</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#Logger.flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.Logger.flush" title="Permalink to this definition">¶</a></dt>
2207 <dd><p>Flush terminal</p>
2208 </dd></dl>
2209
2210 <dl class="method">
2211 <dt id="src.logger.Logger.put_initial_xml_fields">
2212 <code class="descname">put_initial_xml_fields</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#Logger.put_initial_xml_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.Logger.put_initial_xml_fields" title="Permalink to this definition">¶</a></dt>
2213 <dd><p>Called at class initialization: Put all fields
2214 corresponding to the command context (user, time, …)</p>
2215 </dd></dl>
2216
2217 <dl class="method">
2218 <dt id="src.logger.Logger.write">
2219 <code class="descname">write</code><span class="sig-paren">(</span><em>message</em>, <em>level=None</em>, <em>screenOnly=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#Logger.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.Logger.write" title="Permalink to this definition">¶</a></dt>
2220 <dd><p>function used in the commands
2221 to print in the terminal and the log file.</p>
2222 <table class="docutils field-list" frame="void" rules="none">
2223 <col class="field-name" />
2224 <col class="field-body" />
2225 <tbody valign="top">
2226 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2227 <li><strong>str</strong> (<em>message</em>) – The message to print.</li>
2228 <li><strong>int</strong> (<em>level</em>) – The output level corresponding
2229 to the message 0 &lt; level &lt; 6.</li>
2230 <li><strong>boolean</strong> (<em>screenOnly</em>) – if True, do not write in log file.</li>
2231 </ul>
2232 </td>
2233 </tr>
2234 </tbody>
2235 </table>
2236 </dd></dl>
2237
2238 </dd></dl>
2239
2240 <dl class="function">
2241 <dt id="src.logger.date_to_datetime">
2242 <code class="descclassname">src.logger.</code><code class="descname">date_to_datetime</code><span class="sig-paren">(</span><em>date</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#date_to_datetime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.date_to_datetime" title="Permalink to this definition">¶</a></dt>
2243 <dd><p>From a string date in format YYYYMMDD_HHMMSS
2244 returns list year, mon, day, hour, minutes, seconds</p>
2245 <table class="docutils field-list" frame="void" rules="none">
2246 <col class="field-name" />
2247 <col class="field-body" />
2248 <tbody valign="top">
2249 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>date</em>) – The date in format YYYYMMDD_HHMMSS</td>
2250 </tr>
2251 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the same date and time in separate variables.</td>
2252 </tr>
2253 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">(str,str,str,str,str,str)</td>
2254 </tr>
2255 </tbody>
2256 </table>
2257 </dd></dl>
2258
2259 <dl class="function">
2260 <dt id="src.logger.list_log_file">
2261 <code class="descclassname">src.logger.</code><code class="descname">list_log_file</code><span class="sig-paren">(</span><em>dirPath</em>, <em>expression</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#list_log_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.list_log_file" title="Permalink to this definition">¶</a></dt>
2262 <dd><p>Find all files corresponding to expression in dirPath</p>
2263 <table class="docutils field-list" frame="void" rules="none">
2264 <col class="field-name" />
2265 <col class="field-body" />
2266 <tbody valign="top">
2267 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
2268 <li><strong>str</strong> (<em>expression</em>) – the directory where to search the files</li>
2269 <li><strong>str</strong> – the regular expression of files to find</li>
2270 </ul>
2271 </td>
2272 </tr>
2273 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the list of files path and informations about it</p>
2274 </td>
2275 </tr>
2276 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list</p>
2277 </td>
2278 </tr>
2279 </tbody>
2280 </table>
2281 </dd></dl>
2282
2283 <dl class="function">
2284 <dt id="src.logger.show_command_log">
2285 <code class="descclassname">src.logger.</code><code class="descname">show_command_log</code><span class="sig-paren">(</span><em>logFilePath</em>, <em>cmd</em>, <em>application</em>, <em>notShownCommands</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#show_command_log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.show_command_log" title="Permalink to this definition">¶</a></dt>
2286 <dd><p>Used in updateHatXml.
2287 Determine if the log xml file logFilePath
2288 has to be shown or not in the hat log.</p>
2289 <table class="docutils field-list" frame="void" rules="none">
2290 <col class="field-name" />
2291 <col class="field-body" />
2292 <tbody valign="top">
2293 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
2294 <li><strong>str</strong> (<em>application</em>) – the path to the command xml log file</li>
2295 <li><strong>str</strong> – the command of the log file</li>
2296 <li><strong>str</strong> – the application passed as parameter
2297 to the salomeTools command</li>
2298 <li><strong>list</strong> (<em>notShownCommands</em>) – the list of commands
2299 that are not shown by default</li>
2300 </ul>
2301 </td>
2302 </tr>
2303 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if cmd is not in notShownCommands and the application
2304 in the log file corresponds to application</p>
2305 </td>
2306 </tr>
2307 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">boolean</p>
2308 </td>
2309 </tr>
2310 </tbody>
2311 </table>
2312 </dd></dl>
2313
2314 <dl class="function">
2315 <dt id="src.logger.timedelta_total_seconds">
2316 <code class="descclassname">src.logger.</code><code class="descname">timedelta_total_seconds</code><span class="sig-paren">(</span><em>timedelta</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#timedelta_total_seconds"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.timedelta_total_seconds" title="Permalink to this definition">¶</a></dt>
2317 <dd><p>Replace total_seconds from datetime module
2318 in order to be compatible with old python versions</p>
2319 <table class="docutils field-list" frame="void" rules="none">
2320 <col class="field-name" />
2321 <col class="field-body" />
2322 <tbody valign="top">
2323 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>datetime.timedelta</strong> (<em>timedelta</em>) – The delta between two dates</td>
2324 </tr>
2325 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The number of seconds corresponding to timedelta.</td>
2326 </tr>
2327 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">float</td>
2328 </tr>
2329 </tbody>
2330 </table>
2331 </dd></dl>
2332
2333 <dl class="function">
2334 <dt id="src.logger.update_hat_xml">
2335 <code class="descclassname">src.logger.</code><code class="descname">update_hat_xml</code><span class="sig-paren">(</span><em>logDir</em>, <em>application=None</em>, <em>notShownCommands=[]</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/logger.html#update_hat_xml"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.logger.update_hat_xml" title="Permalink to this definition">¶</a></dt>
2336 <dd><p>Create the xml file in logDir that contain all the xml file
2337 and have a name like YYYYMMDD_HHMMSS_namecmd.xml</p>
2338 <table class="docutils field-list" frame="void" rules="none">
2339 <col class="field-name" />
2340 <col class="field-body" />
2341 <tbody valign="top">
2342 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2343 <li><strong>str</strong> (<em>application</em>) – the directory to parse</li>
2344 <li><strong>str</strong> – the name of the application if there is any</li>
2345 </ul>
2346 </td>
2347 </tr>
2348 </tbody>
2349 </table>
2350 </dd></dl>
2351
2352 </div>
2353 <div class="section" id="module-src.options">
2354 <span id="src-options-module"></span><h2>src.options module<a class="headerlink" href="#module-src.options" title="Permalink to this headline">¶</a></h2>
2355 <p>The Options class that manages the access to all options passed as
2356 parameters in salomeTools command lines</p>
2357 <dl class="class">
2358 <dt id="src.options.OptResult">
2359 <em class="property">class </em><code class="descclassname">src.options.</code><code class="descname">OptResult</code><a class="reference internal" href="../../_modules/src/options.html#OptResult"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.OptResult" title="Permalink to this definition">¶</a></dt>
2360 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
2361 <p>An instance of this class will be the object manipulated
2362 in code of all salomeTools commands
2363 The aim of this class is to have an elegant syntax to manipulate the options.</p>
2364 <div class="line-block">
2365 <div class="line">Example:        </div>
2366 <div class="line">&gt;&gt; options, remainderArgs = command.parseArguments(args)</div>
2367 <div class="line">&gt;&gt; print(options.output_verbose_level)</div>
2368 <div class="line">&gt;&gt; ‘INFO’</div>
2369 </div>
2370 </dd></dl>
2371
2372 <dl class="class">
2373 <dt id="src.options.Options">
2374 <em class="property">class </em><code class="descclassname">src.options.</code><code class="descname">Options</code><a class="reference internal" href="../../_modules/src/options.html#Options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options" title="Permalink to this definition">¶</a></dt>
2375 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
2376 <p>Class to manage all salomeTools options</p>
2377 <dl class="method">
2378 <dt id="src.options.Options.add_option">
2379 <code class="descname">add_option</code><span class="sig-paren">(</span><em>shortName</em>, <em>longName</em>, <em>optionType</em>, <em>destName</em>, <em>helpString=''</em>, <em>default=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/options.html#Options.add_option"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options.add_option" title="Permalink to this definition">¶</a></dt>
2380 <dd><p>Add an option to a command. It gets all attributes
2381 of an option and append it in the options field</p>
2382 <table class="docutils field-list" frame="void" rules="none">
2383 <col class="field-name" />
2384 <col class="field-body" />
2385 <tbody valign="top">
2386 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
2387 <li><strong>shortName</strong> – (str)
2388 The short name of the option (as ‘-l’ for level option).</li>
2389 <li><strong>longName</strong> – (str)
2390 The long name of the option (as ‘–level’ for level option).</li>
2391 <li><strong>optionType</strong> – (str) The type of the option (ex “int”).</li>
2392 <li><strong>destName</strong> – (str) The name that will be used in the code.</li>
2393 <li><strong>helpString</strong> – (str)
2394 The text to display when user ask for help on a command.</li>
2395 </ul>
2396 </td>
2397 </tr>
2398 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
2399 </td>
2400 </tr>
2401 </tbody>
2402 </table>
2403 </dd></dl>
2404
2405 <dl class="method">
2406 <dt id="src.options.Options.debug_write">
2407 <code class="descname">debug_write</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/options.html#Options.debug_write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options.debug_write" title="Permalink to this definition">¶</a></dt>
2408 <dd></dd></dl>
2409
2410 <dl class="method">
2411 <dt id="src.options.Options.filterLevel">
2412 <code class="descname">filterLevel</code><span class="sig-paren">(</span><em>aLevel</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/options.html#Options.filterLevel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options.filterLevel" title="Permalink to this definition">¶</a></dt>
2413 <dd><p>filter level logging values</p>
2414 </dd></dl>
2415
2416 <dl class="method">
2417 <dt id="src.options.Options.filterList2">
2418 <code class="descname">filterList2</code><span class="sig-paren">(</span><em>aStr</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/options.html#Options.filterList2"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options.filterList2" title="Permalink to this definition">¶</a></dt>
2419 <dd><p>filter a list as ‘KERNEL,YACS,etc.’</p>
2420 </dd></dl>
2421
2422 <dl class="method">
2423 <dt id="src.options.Options.getDetailOption">
2424 <code class="descname">getDetailOption</code><span class="sig-paren">(</span><em>option</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/options.html#Options.getDetailOption"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options.getDetailOption" title="Permalink to this definition">¶</a></dt>
2425 <dd><p>for convenience</p>
2426 <table class="docutils field-list" frame="void" rules="none">
2427 <col class="field-name" />
2428 <col class="field-body" />
2429 <tbody valign="top">
2430 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">(tuple) 4-elements (shortName, longName, optionType, helpString)</td>
2431 </tr>
2432 </tbody>
2433 </table>
2434 </dd></dl>
2435
2436 <dl class="method">
2437 <dt id="src.options.Options.get_help">
2438 <code class="descname">get_help</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/options.html#Options.get_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options.get_help" title="Permalink to this definition">¶</a></dt>
2439 <dd><p>Returns all options stored in self.options
2440 as help message colored string</p>
2441 <table class="docutils field-list" frame="void" rules="none">
2442 <col class="field-name" />
2443 <col class="field-body" />
2444 <tbody valign="top">
2445 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">(str) colored string</td>
2446 </tr>
2447 </tbody>
2448 </table>
2449 </dd></dl>
2450
2451 <dl class="method">
2452 <dt id="src.options.Options.indent">
2453 <code class="descname">indent</code><span class="sig-paren">(</span><em>text</em>, <em>amount</em>, <em>car=' '</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/options.html#Options.indent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options.indent" title="Permalink to this definition">¶</a></dt>
2454 <dd><p>indent multi lines message</p>
2455 </dd></dl>
2456
2457 <dl class="method">
2458 <dt id="src.options.Options.parse_args">
2459 <code class="descname">parse_args</code><span class="sig-paren">(</span><em>argList=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/options.html#Options.parse_args"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options.parse_args" title="Permalink to this definition">¶</a></dt>
2460 <dd><p>Instantiates the class OptResult
2461 that gives access to all options in the code</p>
2462 <table class="docutils field-list" frame="void" rules="none">
2463 <col class="field-name" />
2464 <col class="field-body" />
2465 <tbody valign="top">
2466 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>argList</strong> – (list) the raw list of arguments that were passed</td>
2467 </tr>
2468 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">(OptResult, list) as (optResult, args)
2469 optResult is the option instance to manipulate in the code.
2470 args is the full raw list of passed options</td>
2471 </tr>
2472 </tbody>
2473 </table>
2474 </dd></dl>
2475
2476 <dl class="method">
2477 <dt id="src.options.Options.print_help">
2478 <code class="descname">print_help</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/options.html#Options.print_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.options.Options.print_help" title="Permalink to this definition">¶</a></dt>
2479 <dd><p>Method that display all options stored in self.options and there help</p>
2480 <table class="docutils field-list" frame="void" rules="none">
2481 <col class="field-name" />
2482 <col class="field-body" />
2483 <tbody valign="top">
2484 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
2485 </tr>
2486 </tbody>
2487 </table>
2488 </dd></dl>
2489
2490 </dd></dl>
2491
2492 </div>
2493 <div class="section" id="module-src.printcolors">
2494 <span id="src-printcolors-module"></span><h2>src.printcolors module<a class="headerlink" href="#module-src.printcolors" title="Permalink to this headline">¶</a></h2>
2495 <p>In this file is stored the mechanism that manage color prints in the terminal</p>
2496 <dl class="function">
2497 <dt id="src.printcolors.cleancolor">
2498 <code class="descclassname">src.printcolors.</code><code class="descname">cleancolor</code><span class="sig-paren">(</span><em>message</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#cleancolor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.cleancolor" title="Permalink to this definition">¶</a></dt>
2499 <dd><p>remove color from a colored text.</p>
2500 <table class="docutils field-list" frame="void" rules="none">
2501 <col class="field-name" />
2502 <col class="field-body" />
2503 <tbody valign="top">
2504 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>message</em>) – The text to be cleaned.</td>
2505 </tr>
2506 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The cleaned text.</td>
2507 </tr>
2508 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
2509 </tr>
2510 </tbody>
2511 </table>
2512 </dd></dl>
2513
2514 <dl class="function">
2515 <dt id="src.printcolors.print_color_map">
2516 <code class="descclassname">src.printcolors.</code><code class="descname">print_color_map</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#print_color_map"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.print_color_map" title="Permalink to this definition">¶</a></dt>
2517 <dd><p>This method prints the color map</p>
2518 </dd></dl>
2519
2520 <dl class="function">
2521 <dt id="src.printcolors.print_color_range">
2522 <code class="descclassname">src.printcolors.</code><code class="descname">print_color_range</code><span class="sig-paren">(</span><em>start</em>, <em>end</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#print_color_range"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.print_color_range" title="Permalink to this definition">¶</a></dt>
2523 <dd><p>print possible range values for colors</p>
2524 <table class="docutils field-list" frame="void" rules="none">
2525 <col class="field-name" />
2526 <col class="field-body" />
2527 <tbody valign="top">
2528 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2529 <li><strong>int</strong> (<em>end</em>) – The smaller value.</li>
2530 <li><strong>int</strong> – The bigger value.</li>
2531 </ul>
2532 </td>
2533 </tr>
2534 </tbody>
2535 </table>
2536 </dd></dl>
2537
2538 <dl class="function">
2539 <dt id="src.printcolors.print_value">
2540 <code class="descclassname">src.printcolors.</code><code class="descname">print_value</code><span class="sig-paren">(</span><em>logger</em>, <em>label</em>, <em>value</em>, <em>level=1</em>, <em>suffix=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#print_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.print_value" title="Permalink to this definition">¶</a></dt>
2541 <dd><p>shortcut method to print a label and a value with the info color</p>
2542 <table class="docutils field-list" frame="void" rules="none">
2543 <col class="field-name" />
2544 <col class="field-body" />
2545 <tbody valign="top">
2546 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2547 <li><strong>class logger</strong> (<em>logger</em>) – the logger instance.</li>
2548 <li><strong>int</strong> (<em>level</em>) – the label to print.</li>
2549 <li><strong>str</strong> (<em>suffix</em>) – the value to print.</li>
2550 <li><strong>int</strong> – the level of verboseness.</li>
2551 <li><strong>str</strong> – the suffix to add at the end.</li>
2552 </ul>
2553 </td>
2554 </tr>
2555 </tbody>
2556 </table>
2557 </dd></dl>
2558
2559 <dl class="function">
2560 <dt id="src.printcolors.printc">
2561 <code class="descclassname">src.printcolors.</code><code class="descname">printc</code><span class="sig-paren">(</span><em>txt</em>, <em>code=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#printc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.printc" title="Permalink to this definition">¶</a></dt>
2562 <dd><p>print a text with colors</p>
2563 <table class="docutils field-list" frame="void" rules="none">
2564 <col class="field-name" />
2565 <col class="field-body" />
2566 <tbody valign="top">
2567 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
2568 <li><strong>str</strong> (<em>code</em>) – The text to be printed.</li>
2569 <li><strong>str</strong> – The color to use.</li>
2570 </ul>
2571 </td>
2572 </tr>
2573 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The colored text.</p>
2574 </td>
2575 </tr>
2576 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
2577 </td>
2578 </tr>
2579 </tbody>
2580 </table>
2581 </dd></dl>
2582
2583 <dl class="function">
2584 <dt id="src.printcolors.printcError">
2585 <code class="descclassname">src.printcolors.</code><code class="descname">printcError</code><span class="sig-paren">(</span><em>txt</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#printcError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.printcError" title="Permalink to this definition">¶</a></dt>
2586 <dd><p>print a text error color</p>
2587 <table class="docutils field-list" frame="void" rules="none">
2588 <col class="field-name" />
2589 <col class="field-body" />
2590 <tbody valign="top">
2591 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>txt</em>) – The text to be printed.</td>
2592 </tr>
2593 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
2594 </tr>
2595 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
2596 </tr>
2597 </tbody>
2598 </table>
2599 </dd></dl>
2600
2601 <dl class="function">
2602 <dt id="src.printcolors.printcHeader">
2603 <code class="descclassname">src.printcolors.</code><code class="descname">printcHeader</code><span class="sig-paren">(</span><em>txt</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#printcHeader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.printcHeader" title="Permalink to this definition">¶</a></dt>
2604 <dd><p>print a text header color</p>
2605 <table class="docutils field-list" frame="void" rules="none">
2606 <col class="field-name" />
2607 <col class="field-body" />
2608 <tbody valign="top">
2609 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>txt</em>) – The text to be printed.</td>
2610 </tr>
2611 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
2612 </tr>
2613 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
2614 </tr>
2615 </tbody>
2616 </table>
2617 </dd></dl>
2618
2619 <dl class="function">
2620 <dt id="src.printcolors.printcHighlight">
2621 <code class="descclassname">src.printcolors.</code><code class="descname">printcHighlight</code><span class="sig-paren">(</span><em>txt</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#printcHighlight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.printcHighlight" title="Permalink to this definition">¶</a></dt>
2622 <dd><p>print a text highlight color</p>
2623 <table class="docutils field-list" frame="void" rules="none">
2624 <col class="field-name" />
2625 <col class="field-body" />
2626 <tbody valign="top">
2627 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>txt</em>) – The text to be printed.</td>
2628 </tr>
2629 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
2630 </tr>
2631 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
2632 </tr>
2633 </tbody>
2634 </table>
2635 </dd></dl>
2636
2637 <dl class="function">
2638 <dt id="src.printcolors.printcInfo">
2639 <code class="descclassname">src.printcolors.</code><code class="descname">printcInfo</code><span class="sig-paren">(</span><em>txt</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#printcInfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.printcInfo" title="Permalink to this definition">¶</a></dt>
2640 <dd><p>print a text info color</p>
2641 <table class="docutils field-list" frame="void" rules="none">
2642 <col class="field-name" />
2643 <col class="field-body" />
2644 <tbody valign="top">
2645 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>txt</em>) – The text to be printed.</td>
2646 </tr>
2647 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
2648 </tr>
2649 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
2650 </tr>
2651 </tbody>
2652 </table>
2653 </dd></dl>
2654
2655 <dl class="function">
2656 <dt id="src.printcolors.printcLabel">
2657 <code class="descclassname">src.printcolors.</code><code class="descname">printcLabel</code><span class="sig-paren">(</span><em>txt</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#printcLabel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.printcLabel" title="Permalink to this definition">¶</a></dt>
2658 <dd><p>print a text label color</p>
2659 <table class="docutils field-list" frame="void" rules="none">
2660 <col class="field-name" />
2661 <col class="field-body" />
2662 <tbody valign="top">
2663 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>txt</em>) – The text to be printed.</td>
2664 </tr>
2665 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
2666 </tr>
2667 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
2668 </tr>
2669 </tbody>
2670 </table>
2671 </dd></dl>
2672
2673 <dl class="function">
2674 <dt id="src.printcolors.printcSuccess">
2675 <code class="descclassname">src.printcolors.</code><code class="descname">printcSuccess</code><span class="sig-paren">(</span><em>txt</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#printcSuccess"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.printcSuccess" title="Permalink to this definition">¶</a></dt>
2676 <dd><p>print a text success color</p>
2677 <table class="docutils field-list" frame="void" rules="none">
2678 <col class="field-name" />
2679 <col class="field-body" />
2680 <tbody valign="top">
2681 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>txt</em>) – The text to be printed.</td>
2682 </tr>
2683 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
2684 </tr>
2685 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
2686 </tr>
2687 </tbody>
2688 </table>
2689 </dd></dl>
2690
2691 <dl class="function">
2692 <dt id="src.printcolors.printcWarning">
2693 <code class="descclassname">src.printcolors.</code><code class="descname">printcWarning</code><span class="sig-paren">(</span><em>txt</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/printcolors.html#printcWarning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.printcolors.printcWarning" title="Permalink to this definition">¶</a></dt>
2694 <dd><p>print a text warning color</p>
2695 <table class="docutils field-list" frame="void" rules="none">
2696 <col class="field-name" />
2697 <col class="field-body" />
2698 <tbody valign="top">
2699 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>txt</em>) – The text to be printed.</td>
2700 </tr>
2701 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
2702 </tr>
2703 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
2704 </tr>
2705 </tbody>
2706 </table>
2707 </dd></dl>
2708
2709 </div>
2710 <div class="section" id="module-src.product">
2711 <span id="src-product-module"></span><h2>src.product module<a class="headerlink" href="#module-src.product" title="Permalink to this headline">¶</a></h2>
2712 <p>In this file are implemented the methods
2713 relative to the product notion of salomeTools</p>
2714 <dl class="function">
2715 <dt id="src.product.check_config_exists">
2716 <code class="descclassname">src.product.</code><code class="descname">check_config_exists</code><span class="sig-paren">(</span><em>config</em>, <em>prod_dir</em>, <em>prod_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#check_config_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.check_config_exists" title="Permalink to this definition">¶</a></dt>
2717 <dd><p>Verify that the installation directory of a product in a base exists
2718 Check all the config-&lt;i&gt; directory and verify the sat-config.pyconf file
2719 that is in it</p>
2720 <table class="docutils field-list" frame="void" rules="none">
2721 <col class="field-name" />
2722 <col class="field-body" />
2723 <tbody valign="top">
2724 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
2725 <li><strong>Config</strong> (<em>product_info</em>) – The global configuration</li>
2726 <li><strong>str</strong> (<em>prod_dir</em>) – The product installation directory path
2727 (without config-&lt;i&gt;)</li>
2728 <li><strong>Config</strong> – The configuration specific to
2729 the product</li>
2730 </ul>
2731 </td>
2732 </tr>
2733 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True or false is the installation is found or not
2734 and if it is found, the path of the found installation</p>
2735 </td>
2736 </tr>
2737 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">(boolean, str)</p>
2738 </td>
2739 </tr>
2740 </tbody>
2741 </table>
2742 </dd></dl>
2743
2744 <dl class="function">
2745 <dt id="src.product.check_installation">
2746 <code class="descclassname">src.product.</code><code class="descname">check_installation</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#check_installation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.check_installation" title="Permalink to this definition">¶</a></dt>
2747 <dd><p>Verify if a product is well installed. Checks install directory presence
2748 and some additional files if it is defined in the config</p>
2749 <table class="docutils field-list" frame="void" rules="none">
2750 <col class="field-name" />
2751 <col class="field-body" />
2752 <tbody valign="top">
2753 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
2754 the product</td>
2755 </tr>
2756 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if it is well installed</td>
2757 </tr>
2758 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
2759 </tr>
2760 </tbody>
2761 </table>
2762 </dd></dl>
2763
2764 <dl class="function">
2765 <dt id="src.product.check_source">
2766 <code class="descclassname">src.product.</code><code class="descname">check_source</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#check_source"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.check_source" title="Permalink to this definition">¶</a></dt>
2767 <dd><p>Verify if a sources of product is preset. Checks source directory presence</p>
2768 <table class="docutils field-list" frame="void" rules="none">
2769 <col class="field-name" />
2770 <col class="field-body" />
2771 <tbody valign="top">
2772 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
2773 the product</td>
2774 </tr>
2775 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if it is well installed</td>
2776 </tr>
2777 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
2778 </tr>
2779 </tbody>
2780 </table>
2781 </dd></dl>
2782
2783 <dl class="function">
2784 <dt id="src.product.get_base_install_dir">
2785 <code class="descclassname">src.product.</code><code class="descname">get_base_install_dir</code><span class="sig-paren">(</span><em>config</em>, <em>prod_info</em>, <em>version</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_base_install_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_base_install_dir" title="Permalink to this definition">¶</a></dt>
2786 <dd><p>Compute the installation directory of a product in base</p>
2787 <table class="docutils field-list" frame="void" rules="none">
2788 <col class="field-name" />
2789 <col class="field-body" />
2790 <tbody valign="top">
2791 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
2792 <li><strong>Config</strong> (<em>product_info</em>) – The global configuration</li>
2793 <li><strong>Config</strong> – The configuration specific to
2794 the product</li>
2795 <li><strong>str</strong> (<em>version</em>) – The version of the product</li>
2796 </ul>
2797 </td>
2798 </tr>
2799 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The path of the product installation</p>
2800 </td>
2801 </tr>
2802 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
2803 </td>
2804 </tr>
2805 </tbody>
2806 </table>
2807 </dd></dl>
2808
2809 <dl class="function">
2810 <dt id="src.product.get_install_dir">
2811 <code class="descclassname">src.product.</code><code class="descname">get_install_dir</code><span class="sig-paren">(</span><em>config</em>, <em>base</em>, <em>version</em>, <em>prod_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_install_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_install_dir" title="Permalink to this definition">¶</a></dt>
2812 <dd><p>Compute the installation directory of a given product</p>
2813 <table class="docutils field-list" frame="void" rules="none">
2814 <col class="field-name" />
2815 <col class="field-body" />
2816 <tbody valign="top">
2817 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
2818 <li><strong>Config</strong> (<em>product_info</em>) – The global configuration</li>
2819 <li><strong>str</strong> (<em>version</em>) – This corresponds to the value given by user in its
2820 application.pyconf for the specific product. If “yes”, the
2821 user wants the product to be in base. If “no”, he wants the
2822 product to be in the application workdir</li>
2823 <li><strong>str</strong> – The version of the product</li>
2824 <li><strong>Config</strong> – The configuration specific to
2825 the product</li>
2826 </ul>
2827 </td>
2828 </tr>
2829 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The path of the product installation</p>
2830 </td>
2831 </tr>
2832 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
2833 </td>
2834 </tr>
2835 </tbody>
2836 </table>
2837 </dd></dl>
2838
2839 <dl class="function">
2840 <dt id="src.product.get_product_components">
2841 <code class="descclassname">src.product.</code><code class="descname">get_product_components</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_product_components"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_product_components" title="Permalink to this definition">¶</a></dt>
2842 <dd><p>Get the component list to generate with the product</p>
2843 <table class="docutils field-list" frame="void" rules="none">
2844 <col class="field-name" />
2845 <col class="field-body" />
2846 <tbody valign="top">
2847 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
2848 the product</td>
2849 </tr>
2850 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The list of names of the components</td>
2851 </tr>
2852 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">List</td>
2853 </tr>
2854 </tbody>
2855 </table>
2856 </dd></dl>
2857
2858 <dl class="function">
2859 <dt id="src.product.get_product_config">
2860 <code class="descclassname">src.product.</code><code class="descname">get_product_config</code><span class="sig-paren">(</span><em>config</em>, <em>product_name</em>, <em>with_install_dir=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_product_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_product_config" title="Permalink to this definition">¶</a></dt>
2861 <dd><p>Get the specific configuration of a product from the global configuration</p>
2862 <table class="docutils field-list" frame="void" rules="none">
2863 <col class="field-name" />
2864 <col class="field-body" />
2865 <tbody valign="top">
2866 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
2867 <li><strong>Config</strong> (<em>config</em>) – The global configuration</li>
2868 <li><strong>str</strong> (<em>product_name</em>) – The name of the product</li>
2869 <li><strong>boolean</strong> (<em>with_install_dir</em>) – If false, do not provide an install
2870 directory (at false only for internal use
2871 of the function check_config_exists)</li>
2872 </ul>
2873 </td>
2874 </tr>
2875 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the specific configuration of the product</p>
2876 </td>
2877 </tr>
2878 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#src.pyconf.Config" title="src.pyconf.Config">Config</a></p>
2879 </td>
2880 </tr>
2881 </tbody>
2882 </table>
2883 </dd></dl>
2884
2885 <dl class="function">
2886 <dt id="src.product.get_product_dependencies">
2887 <code class="descclassname">src.product.</code><code class="descname">get_product_dependencies</code><span class="sig-paren">(</span><em>config</em>, <em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_product_dependencies"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_product_dependencies" title="Permalink to this definition">¶</a></dt>
2888 <dd><p>Get recursively the list of products that are
2889 in the product_info dependencies</p>
2890 <table class="docutils field-list" frame="void" rules="none">
2891 <col class="field-name" />
2892 <col class="field-body" />
2893 <tbody valign="top">
2894 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
2895 <li><strong>Config</strong> (<em>product_info</em>) – The global configuration</li>
2896 <li><strong>Config</strong> – The configuration specific to
2897 the product</li>
2898 </ul>
2899 </td>
2900 </tr>
2901 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the list of products in dependence</p>
2902 </td>
2903 </tr>
2904 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list</p>
2905 </td>
2906 </tr>
2907 </tbody>
2908 </table>
2909 </dd></dl>
2910
2911 <dl class="function">
2912 <dt id="src.product.get_product_section">
2913 <code class="descclassname">src.product.</code><code class="descname">get_product_section</code><span class="sig-paren">(</span><em>config</em>, <em>product_name</em>, <em>version</em>, <em>section=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_product_section"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_product_section" title="Permalink to this definition">¶</a></dt>
2914 <dd><p>Get the product description from the configuration</p>
2915 <table class="docutils field-list" frame="void" rules="none">
2916 <col class="field-name" />
2917 <col class="field-body" />
2918 <tbody valign="top">
2919 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
2920 <li><strong>Config</strong> (<em>config</em>) – The global configuration</li>
2921 <li><strong>str</strong> (<em>section</em>) – The product name</li>
2922 <li><strong>str</strong> – The version of the product</li>
2923 <li><strong>str</strong> – The searched section (if not None, the section is
2924 explicitly given</li>
2925 </ul>
2926 </td>
2927 </tr>
2928 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The product description</p>
2929 </td>
2930 </tr>
2931 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#src.pyconf.Config" title="src.pyconf.Config">Config</a></p>
2932 </td>
2933 </tr>
2934 </tbody>
2935 </table>
2936 </dd></dl>
2937
2938 <dl class="function">
2939 <dt id="src.product.get_products_infos">
2940 <code class="descclassname">src.product.</code><code class="descname">get_products_infos</code><span class="sig-paren">(</span><em>lproducts</em>, <em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#get_products_infos"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.get_products_infos" title="Permalink to this definition">¶</a></dt>
2941 <dd><p>Get the specific configuration of a list of products</p>
2942 <table class="docutils field-list" frame="void" rules="none">
2943 <col class="field-name" />
2944 <col class="field-body" />
2945 <tbody valign="top">
2946 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
2947 <li><strong>List</strong> (<em>lproducts</em>) – The list of product names</li>
2948 <li><strong>Config</strong> (<em>config</em>) – The global configuration</li>
2949 </ul>
2950 </td>
2951 </tr>
2952 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the list of tuples
2953 (product name, specific configuration of the product)</p>
2954 </td>
2955 </tr>
2956 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">[(str, <a class="reference internal" href="#src.pyconf.Config" title="src.pyconf.Config">Config</a>)]</p>
2957 </td>
2958 </tr>
2959 </tbody>
2960 </table>
2961 </dd></dl>
2962
2963 <dl class="function">
2964 <dt id="src.product.product_compiles">
2965 <code class="descclassname">src.product.</code><code class="descname">product_compiles</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_compiles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_compiles" title="Permalink to this definition">¶</a></dt>
2966 <dd><p>Know if a product compiles or not
2967 (some products do not have a compilation procedure)</p>
2968 <table class="docutils field-list" frame="void" rules="none">
2969 <col class="field-name" />
2970 <col class="field-body" />
2971 <tbody valign="top">
2972 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
2973 the product</td>
2974 </tr>
2975 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product compiles, else False</td>
2976 </tr>
2977 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
2978 </tr>
2979 </tbody>
2980 </table>
2981 </dd></dl>
2982
2983 <dl class="function">
2984 <dt id="src.product.product_has_env_script">
2985 <code class="descclassname">src.product.</code><code class="descname">product_has_env_script</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_has_env_script"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_has_env_script" title="Permalink to this definition">¶</a></dt>
2986 <dd><p>Know if a product has an environment script</p>
2987 <table class="docutils field-list" frame="void" rules="none">
2988 <col class="field-name" />
2989 <col class="field-body" />
2990 <tbody valign="top">
2991 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
2992 the product</td>
2993 </tr>
2994 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product it has an environment script, else False</td>
2995 </tr>
2996 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
2997 </tr>
2998 </tbody>
2999 </table>
3000 </dd></dl>
3001
3002 <dl class="function">
3003 <dt id="src.product.product_has_logo">
3004 <code class="descclassname">src.product.</code><code class="descname">product_has_logo</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_has_logo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_has_logo" title="Permalink to this definition">¶</a></dt>
3005 <dd><p>Know if a product has a logo (YACSGEN generate)</p>
3006 <table class="docutils field-list" frame="void" rules="none">
3007 <col class="field-name" />
3008 <col class="field-body" />
3009 <tbody valign="top">
3010 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
3011 the product</td>
3012 </tr>
3013 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The path of the logo if the product has a logo, else False</td>
3014 </tr>
3015 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Str</td>
3016 </tr>
3017 </tbody>
3018 </table>
3019 </dd></dl>
3020
3021 <dl class="function">
3022 <dt id="src.product.product_has_patches">
3023 <code class="descclassname">src.product.</code><code class="descname">product_has_patches</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_has_patches"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_has_patches" title="Permalink to this definition">¶</a></dt>
3024 <dd><p>Know if a product has one or more patches</p>
3025 <table class="docutils field-list" frame="void" rules="none">
3026 <col class="field-name" />
3027 <col class="field-body" />
3028 <tbody valign="top">
3029 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
3030 the product</td>
3031 </tr>
3032 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product has one or more patches</td>
3033 </tr>
3034 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3035 </tr>
3036 </tbody>
3037 </table>
3038 </dd></dl>
3039
3040 <dl class="function">
3041 <dt id="src.product.product_has_salome_gui">
3042 <code class="descclassname">src.product.</code><code class="descname">product_has_salome_gui</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_has_salome_gui"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_has_salome_gui" title="Permalink to this definition">¶</a></dt>
3043 <dd><p>Know if a product has a SALOME gui</p>
3044 <table class="docutils field-list" frame="void" rules="none">
3045 <col class="field-name" />
3046 <col class="field-body" />
3047 <tbody valign="top">
3048 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
3049 the product</td>
3050 </tr>
3051 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product has a SALOME gui, else False</td>
3052 </tr>
3053 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Boolean</td>
3054 </tr>
3055 </tbody>
3056 </table>
3057 </dd></dl>
3058
3059 <dl class="function">
3060 <dt id="src.product.product_has_script">
3061 <code class="descclassname">src.product.</code><code class="descname">product_has_script</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_has_script"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_has_script" title="Permalink to this definition">¶</a></dt>
3062 <dd><p>Know if a product has a compilation script</p>
3063 <table class="docutils field-list" frame="void" rules="none">
3064 <col class="field-name" />
3065 <col class="field-body" />
3066 <tbody valign="top">
3067 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
3068 the product</td>
3069 </tr>
3070 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product it has a compilation script, else False</td>
3071 </tr>
3072 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3073 </tr>
3074 </tbody>
3075 </table>
3076 </dd></dl>
3077
3078 <dl class="function">
3079 <dt id="src.product.product_is_autotools">
3080 <code class="descclassname">src.product.</code><code class="descname">product_is_autotools</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_autotools"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_autotools" title="Permalink to this definition">¶</a></dt>
3081 <dd><p>Know if a product is compiled using the autotools</p>
3082 <table class="docutils field-list" frame="void" rules="none">
3083 <col class="field-name" />
3084 <col class="field-body" />
3085 <tbody valign="top">
3086 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
3087 the product</td>
3088 </tr>
3089 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is autotools, else False</td>
3090 </tr>
3091 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3092 </tr>
3093 </tbody>
3094 </table>
3095 </dd></dl>
3096
3097 <dl class="function">
3098 <dt id="src.product.product_is_cmake">
3099 <code class="descclassname">src.product.</code><code class="descname">product_is_cmake</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_cmake"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_cmake" title="Permalink to this definition">¶</a></dt>
3100 <dd><p>Know if a product is compiled using the cmake</p>
3101 <table class="docutils field-list" frame="void" rules="none">
3102 <col class="field-name" />
3103 <col class="field-body" />
3104 <tbody valign="top">
3105 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
3106 the product</td>
3107 </tr>
3108 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is cmake, else False</td>
3109 </tr>
3110 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3111 </tr>
3112 </tbody>
3113 </table>
3114 </dd></dl>
3115
3116 <dl class="function">
3117 <dt id="src.product.product_is_cpp">
3118 <code class="descclassname">src.product.</code><code class="descname">product_is_cpp</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_cpp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_cpp" title="Permalink to this definition">¶</a></dt>
3119 <dd><p>Know if a product is cpp</p>
3120 <table class="docutils field-list" frame="void" rules="none">
3121 <col class="field-name" />
3122 <col class="field-body" />
3123 <tbody valign="top">
3124 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
3125 the product</td>
3126 </tr>
3127 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is a cpp, else False</td>
3128 </tr>
3129 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3130 </tr>
3131 </tbody>
3132 </table>
3133 </dd></dl>
3134
3135 <dl class="function">
3136 <dt id="src.product.product_is_debug">
3137 <code class="descclassname">src.product.</code><code class="descname">product_is_debug</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_debug"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_debug" title="Permalink to this definition">¶</a></dt>
3138 <dd><p>Know if a product is in debug mode</p>
3139 <table class="docutils field-list" frame="void" rules="none">
3140 <col class="field-name" />
3141 <col class="field-body" />
3142 <tbody valign="top">
3143 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
3144 the product</td>
3145 </tr>
3146 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is in debug mode, else False</td>
3147 </tr>
3148 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3149 </tr>
3150 </tbody>
3151 </table>
3152 </dd></dl>
3153
3154 <dl class="function">
3155 <dt id="src.product.product_is_dev">
3156 <code class="descclassname">src.product.</code><code class="descname">product_is_dev</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_dev"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_dev" title="Permalink to this definition">¶</a></dt>
3157 <dd><p>Know if a product is in dev mode</p>
3158 <table class="docutils field-list" frame="void" rules="none">
3159 <col class="field-name" />
3160 <col class="field-body" />
3161 <tbody valign="top">
3162 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
3163 the product</td>
3164 </tr>
3165 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is in dev mode, else False</td>
3166 </tr>
3167 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3168 </tr>
3169 </tbody>
3170 </table>
3171 </dd></dl>
3172
3173 <dl class="function">
3174 <dt id="src.product.product_is_fixed">
3175 <code class="descclassname">src.product.</code><code class="descname">product_is_fixed</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_fixed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_fixed" title="Permalink to this definition">¶</a></dt>
3176 <dd><p>Know if a product is fixed</p>
3177 <table class="docutils field-list" frame="void" rules="none">
3178 <col class="field-name" />
3179 <col class="field-body" />
3180 <tbody valign="top">
3181 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
3182 the product</td>
3183 </tr>
3184 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is fixed, else False</td>
3185 </tr>
3186 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3187 </tr>
3188 </tbody>
3189 </table>
3190 </dd></dl>
3191
3192 <dl class="function">
3193 <dt id="src.product.product_is_generated">
3194 <code class="descclassname">src.product.</code><code class="descname">product_is_generated</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_generated"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_generated" title="Permalink to this definition">¶</a></dt>
3195 <dd><p>Know if a product is generated (YACSGEN)</p>
3196 <table class="docutils field-list" frame="void" rules="none">
3197 <col class="field-name" />
3198 <col class="field-body" />
3199 <tbody valign="top">
3200 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
3201 the product</td>
3202 </tr>
3203 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is generated</td>
3204 </tr>
3205 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3206 </tr>
3207 </tbody>
3208 </table>
3209 </dd></dl>
3210
3211 <dl class="function">
3212 <dt id="src.product.product_is_mpi">
3213 <code class="descclassname">src.product.</code><code class="descname">product_is_mpi</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_mpi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_mpi" title="Permalink to this definition">¶</a></dt>
3214 <dd><p>Know if a product has openmpi in its dependencies</p>
3215 <table class="docutils field-list" frame="void" rules="none">
3216 <col class="field-name" />
3217 <col class="field-body" />
3218 <tbody valign="top">
3219 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
3220 the product</td>
3221 </tr>
3222 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product has openmpi inits dependencies</td>
3223 </tr>
3224 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3225 </tr>
3226 </tbody>
3227 </table>
3228 </dd></dl>
3229
3230 <dl class="function">
3231 <dt id="src.product.product_is_native">
3232 <code class="descclassname">src.product.</code><code class="descname">product_is_native</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_native"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_native" title="Permalink to this definition">¶</a></dt>
3233 <dd><p>Know if a product is native</p>
3234 <table class="docutils field-list" frame="void" rules="none">
3235 <col class="field-name" />
3236 <col class="field-body" />
3237 <tbody valign="top">
3238 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
3239 the product</td>
3240 </tr>
3241 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is native, else False</td>
3242 </tr>
3243 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3244 </tr>
3245 </tbody>
3246 </table>
3247 </dd></dl>
3248
3249 <dl class="function">
3250 <dt id="src.product.product_is_salome">
3251 <code class="descclassname">src.product.</code><code class="descname">product_is_salome</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_salome"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_salome" title="Permalink to this definition">¶</a></dt>
3252 <dd><p>Know if a product is a SALOME module</p>
3253 <table class="docutils field-list" frame="void" rules="none">
3254 <col class="field-name" />
3255 <col class="field-body" />
3256 <tbody valign="top">
3257 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
3258 the product</td>
3259 </tr>
3260 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is a SALOME module, else False</td>
3261 </tr>
3262 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3263 </tr>
3264 </tbody>
3265 </table>
3266 </dd></dl>
3267
3268 <dl class="function">
3269 <dt id="src.product.product_is_smesh_plugin">
3270 <code class="descclassname">src.product.</code><code class="descname">product_is_smesh_plugin</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_smesh_plugin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_smesh_plugin" title="Permalink to this definition">¶</a></dt>
3271 <dd><p>Know if a product is a SMESH plugin</p>
3272 <table class="docutils field-list" frame="void" rules="none">
3273 <col class="field-name" />
3274 <col class="field-body" />
3275 <tbody valign="top">
3276 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
3277 the product</td>
3278 </tr>
3279 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is a SMESH plugin, else False</td>
3280 </tr>
3281 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3282 </tr>
3283 </tbody>
3284 </table>
3285 </dd></dl>
3286
3287 <dl class="function">
3288 <dt id="src.product.product_is_vcs">
3289 <code class="descclassname">src.product.</code><code class="descname">product_is_vcs</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_vcs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_vcs" title="Permalink to this definition">¶</a></dt>
3290 <dd><p>Know if a product is download using git, svn or cvs (not archive)</p>
3291 <table class="docutils field-list" frame="void" rules="none">
3292 <col class="field-name" />
3293 <col class="field-body" />
3294 <tbody valign="top">
3295 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
3296 the product</td>
3297 </tr>
3298 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is vcs, else False</td>
3299 </tr>
3300 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3301 </tr>
3302 </tbody>
3303 </table>
3304 </dd></dl>
3305
3306 <dl class="function">
3307 <dt id="src.product.product_is_verbose">
3308 <code class="descclassname">src.product.</code><code class="descname">product_is_verbose</code><span class="sig-paren">(</span><em>product_info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/product.html#product_is_verbose"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_verbose" title="Permalink to this definition">¶</a></dt>
3309 <dd><p>Know if a product is in verbose mode</p>
3310 <table class="docutils field-list" frame="void" rules="none">
3311 <col class="field-name" />
3312 <col class="field-body" />
3313 <tbody valign="top">
3314 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>product_info</em>) – The configuration specific to
3315 the product</td>
3316 </tr>
3317 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is in verbose mode, else False</td>
3318 </tr>
3319 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3320 </tr>
3321 </tbody>
3322 </table>
3323 </dd></dl>
3324
3325 </div>
3326 <div class="section" id="module-src.pyconf">
3327 <span id="src-pyconf-module"></span><h2>src.pyconf module<a class="headerlink" href="#module-src.pyconf" title="Permalink to this headline">¶</a></h2>
3328 <p>This is a configuration module for Python.</p>
3329 <p>This module should work under Python versions &gt;= 2.2, and cannot be used with
3330 earlier versions since it uses new-style classes.</p>
3331 <p>Development and testing has only been carried out (so far) on Python 2.3.4 and
3332 Python 2.4.2. See the test module (test_config.py) included in the
3333 U{distribution&lt;<a class="reference external" href="http://www.red-dove.com/python_config">http://www.red-dove.com/python_config</a>.html|_blank&gt;} (follow the
3334 download link).</p>
3335 <p>A simple example - with the example configuration file:</p>
3336 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>messages:
3337 [
3338   {
3339     stream : `sys.stderr`
3340     message: &#39;Welcome&#39;
3341     name: &#39;Harry&#39;
3342   }
3343   {
3344     stream : `sys.stdout`
3345     message: &#39;Welkom&#39;
3346     name: &#39;Ruud&#39;
3347   }
3348   {
3349     stream : $messages[0].stream
3350     message: &#39;Bienvenue&#39;
3351     name: Yves
3352   }
3353 ]
3354 </pre></div>
3355 </div>
3356 <p>a program to read the configuration would be:</p>
3357 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">config</span> <span class="k">import</span> <span class="n">Config</span>
3358
3359 <span class="n">f</span> <span class="o">=</span> <span class="n">file</span><span class="p">(</span><span class="s1">&#39;simple.cfg&#39;</span><span class="p">)</span>
3360 <span class="n">cfg</span> <span class="o">=</span> <span class="n">Config</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
3361 <span class="k">for</span> <span class="n">m</span> <span class="ow">in</span> <span class="n">cfg</span><span class="o">.</span><span class="n">messages</span><span class="p">:</span>
3362     <span class="n">s</span> <span class="o">=</span> <span class="s1">&#39;</span><span class="si">%s</span><span class="s1">, </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">message</span><span class="p">,</span> <span class="n">m</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
3363     <span class="k">try</span><span class="p">:</span>
3364         <span class="nb">print</span> <span class="o">&gt;&gt;</span> <span class="n">m</span><span class="o">.</span><span class="n">stream</span><span class="p">,</span> <span class="n">s</span>
3365     <span class="k">except</span> <span class="ne">IOError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
3366         <span class="nb">print</span> <span class="n">e</span>
3367 </pre></div>
3368 </div>
3369 <p>which, when run, would yield the console output:</p>
3370 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Welcome</span><span class="p">,</span> <span class="n">Harry</span>
3371 <span class="n">Welkom</span><span class="p">,</span> <span class="n">Ruud</span>
3372 <span class="n">Bienvenue</span><span class="p">,</span> <span class="n">Yves</span>
3373 </pre></div>
3374 </div>
3375 <p>See U{this tutorial&lt;<a class="reference external" href="http://www.red-dove.com/python_config">http://www.red-dove.com/python_config</a>.html|_blank&gt;} for more
3376 information.</p>
3377 <p>#modified for salomeTools
3378 &#64;version: 0.3.7.1</p>
3379 <p>&#64;author: Vinay Sajip</p>
3380 <p>&#64;copyright: Copyright (C) 2004-2007 Vinay Sajip. All Rights Reserved.</p>
3381 <p>&#64;var streamOpener: The default stream opener. This is a factory function which
3382 takes a string (e.g. filename) and returns a stream suitable for reading. If
3383 unable to open the stream, an IOError exception should be thrown.</p>
3384 <p>The default value of this variable is L{defaultStreamOpener}. For an example
3385 of how it’s used, see test_config.py (search for streamOpener).</p>
3386 <dl class="class">
3387 <dt id="src.pyconf.Config">
3388 <em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">Config</code><span class="sig-paren">(</span><em>streamOrFile=None</em>, <em>parent=None</em>, <em>PWD=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Config" title="Permalink to this definition">¶</a></dt>
3389 <dd><p>Bases: <a class="reference internal" href="#src.pyconf.Mapping" title="src.pyconf.Mapping"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.pyconf.Mapping</span></code></a></p>
3390 <p>This class represents a configuration, and is the only one which clients
3391 need to interface to, under normal circumstances.</p>
3392 <dl class="class">
3393 <dt id="src.pyconf.Config.Namespace">
3394 <em class="property">class </em><code class="descname">Namespace</code><a class="reference internal" href="../../_modules/src/pyconf.html#Config.Namespace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Config.Namespace" title="Permalink to this definition">¶</a></dt>
3395 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
3396 <p>This internal class is used for implementing default namespaces.</p>
3397 <p>An instance acts as a namespace.</p>
3398 </dd></dl>
3399
3400 <dl class="method">
3401 <dt id="src.pyconf.Config.addNamespace">
3402 <code class="descname">addNamespace</code><span class="sig-paren">(</span><em>ns</em>, <em>name=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Config.addNamespace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Config.addNamespace" title="Permalink to this definition">¶</a></dt>
3403 <dd><p>Add a namespace to this configuration which can be used to evaluate
3404 (resolve) dotted-identifier expressions.
3405 &#64;param ns: The namespace to be added.
3406 &#64;type ns: A module or other namespace suitable for passing as an
3407 argument to vars().
3408 &#64;param name: A name for the namespace, which, if specified, provides
3409 an additional level of indirection.
3410 &#64;type name: str</p>
3411 </dd></dl>
3412
3413 <dl class="method">
3414 <dt id="src.pyconf.Config.getByPath">
3415 <code class="descname">getByPath</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Config.getByPath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Config.getByPath" title="Permalink to this definition">¶</a></dt>
3416 <dd><p>Obtain a value in the configuration via its path.
3417 &#64;param path: The path of the required value
3418 &#64;type path: str
3419 &#64;return the value at the specified path.
3420 &#64;rtype: any
3421 &#64;raise ConfigError: If the path is invalid</p>
3422 </dd></dl>
3423
3424 <dl class="method">
3425 <dt id="src.pyconf.Config.load">
3426 <code class="descname">load</code><span class="sig-paren">(</span><em>stream</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Config.load"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Config.load" title="Permalink to this definition">¶</a></dt>
3427 <dd><p>Load the configuration from the specified stream. Multiple streams can
3428 be used to populate the same instance, as long as there are no
3429 clashing keys. The stream is closed.
3430 &#64;param stream: A stream from which the configuration is read.
3431 &#64;type stream: A read-only stream (file-like object).
3432 &#64;raise ConfigError: if keys in the loaded configuration clash with
3433 existing keys.
3434 &#64;raise ConfigFormatError: if there is a syntax error in the stream.</p>
3435 </dd></dl>
3436
3437 <dl class="method">
3438 <dt id="src.pyconf.Config.removeNamespace">
3439 <code class="descname">removeNamespace</code><span class="sig-paren">(</span><em>ns</em>, <em>name=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Config.removeNamespace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Config.removeNamespace" title="Permalink to this definition">¶</a></dt>
3440 <dd><p>Remove a namespace added with L{addNamespace}.
3441 &#64;param ns: The namespace to be removed.
3442 &#64;param name: The name which was specified when L{addNamespace} was
3443 called.
3444 &#64;type name: str</p>
3445 </dd></dl>
3446
3447 </dd></dl>
3448
3449 <dl class="exception">
3450 <dt id="src.pyconf.ConfigError">
3451 <em class="property">exception </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigError</code><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigError" title="Permalink to this definition">¶</a></dt>
3452 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">exceptions.Exception</span></code></p>
3453 <p>This is the base class of exceptions raised by this module.</p>
3454 </dd></dl>
3455
3456 <dl class="exception">
3457 <dt id="src.pyconf.ConfigFormatError">
3458 <em class="property">exception </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigFormatError</code><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigFormatError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigFormatError" title="Permalink to this definition">¶</a></dt>
3459 <dd><p>Bases: <a class="reference internal" href="#src.pyconf.ConfigError" title="src.pyconf.ConfigError"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.pyconf.ConfigError</span></code></a></p>
3460 <p>This is the base class of exceptions raised due to syntax errors in
3461 configurations.</p>
3462 </dd></dl>
3463
3464 <dl class="class">
3465 <dt id="src.pyconf.ConfigInputStream">
3466 <em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigInputStream</code><span class="sig-paren">(</span><em>stream</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigInputStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigInputStream" title="Permalink to this definition">¶</a></dt>
3467 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
3468 <p>An input stream which can read either ANSI files with default encoding
3469 or Unicode files with BOMs.</p>
3470 <p>Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
3471 built-in support.</p>
3472 <dl class="method">
3473 <dt id="src.pyconf.ConfigInputStream.close">
3474 <code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigInputStream.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigInputStream.close" title="Permalink to this definition">¶</a></dt>
3475 <dd></dd></dl>
3476
3477 <dl class="method">
3478 <dt id="src.pyconf.ConfigInputStream.read">
3479 <code class="descname">read</code><span class="sig-paren">(</span><em>size</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigInputStream.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigInputStream.read" title="Permalink to this definition">¶</a></dt>
3480 <dd></dd></dl>
3481
3482 <dl class="method">
3483 <dt id="src.pyconf.ConfigInputStream.readline">
3484 <code class="descname">readline</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigInputStream.readline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigInputStream.readline" title="Permalink to this definition">¶</a></dt>
3485 <dd></dd></dl>
3486
3487 </dd></dl>
3488
3489 <dl class="class">
3490 <dt id="src.pyconf.ConfigList">
3491 <em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigList</code><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigList"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigList" title="Permalink to this definition">¶</a></dt>
3492 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></p>
3493 <p>This class implements an ordered list of configurations and allows you
3494 to try getting the configuration from each entry in turn, returning
3495 the first successfully obtained value.</p>
3496 <dl class="method">
3497 <dt id="src.pyconf.ConfigList.getByPath">
3498 <code class="descname">getByPath</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigList.getByPath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigList.getByPath" title="Permalink to this definition">¶</a></dt>
3499 <dd><p>Obtain a value from the first configuration in the list which defines
3500 it.</p>
3501 <p>&#64;param path: The path of the value to retrieve.
3502 &#64;type path: str
3503 &#64;return: The value from the earliest configuration in the list which
3504 defines it.
3505 &#64;rtype: any
3506 &#64;raise ConfigError: If no configuration in the list has an entry with
3507 the specified path.</p>
3508 </dd></dl>
3509
3510 </dd></dl>
3511
3512 <dl class="class">
3513 <dt id="src.pyconf.ConfigMerger">
3514 <em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigMerger</code><span class="sig-paren">(</span><em>resolver=&lt;function defaultMergeResolve&gt;</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigMerger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigMerger" title="Permalink to this definition">¶</a></dt>
3515 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
3516 <p>This class is used for merging two configurations. If a key exists in the
3517 merge operand but not the merge target, then the entry is copied from the
3518 merge operand to the merge target. If a key exists in both configurations,
3519 then a resolver (a callable) is called to decide how to handle the
3520 conflict.</p>
3521 <dl class="method">
3522 <dt id="src.pyconf.ConfigMerger.handleMismatch">
3523 <code class="descname">handleMismatch</code><span class="sig-paren">(</span><em>obj1</em>, <em>obj2</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigMerger.handleMismatch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigMerger.handleMismatch" title="Permalink to this definition">¶</a></dt>
3524 <dd><p>Handle a mismatch between two objects.</p>
3525 <p>&#64;param obj1: The object to merge into.
3526 &#64;type obj1: any
3527 &#64;param obj2: The object to merge.
3528 &#64;type obj2: any</p>
3529 </dd></dl>
3530
3531 <dl class="method">
3532 <dt id="src.pyconf.ConfigMerger.merge">
3533 <code class="descname">merge</code><span class="sig-paren">(</span><em>merged</em>, <em>mergee</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigMerger.merge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigMerger.merge" title="Permalink to this definition">¶</a></dt>
3534 <dd><p>Merge two configurations. The second configuration is unchanged,
3535 and the first is changed to reflect the results of the merge.</p>
3536 <p>&#64;param merged: The configuration to merge into.
3537 &#64;type merged: L{Config}.
3538 &#64;param mergee: The configuration to merge.
3539 &#64;type mergee: L{Config}.</p>
3540 </dd></dl>
3541
3542 <dl class="method">
3543 <dt id="src.pyconf.ConfigMerger.mergeMapping">
3544 <code class="descname">mergeMapping</code><span class="sig-paren">(</span><em>map1</em>, <em>map2</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigMerger.mergeMapping"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigMerger.mergeMapping" title="Permalink to this definition">¶</a></dt>
3545 <dd><p>Merge two mappings recursively. The second mapping is unchanged,
3546 and the first is changed to reflect the results of the merge.</p>
3547 <p>&#64;param map1: The mapping to merge into.
3548 &#64;type map1: L{Mapping}.
3549 &#64;param map2: The mapping to merge.
3550 &#64;type map2: L{Mapping}.</p>
3551 </dd></dl>
3552
3553 <dl class="method">
3554 <dt id="src.pyconf.ConfigMerger.mergeSequence">
3555 <code class="descname">mergeSequence</code><span class="sig-paren">(</span><em>seq1</em>, <em>seq2</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigMerger.mergeSequence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigMerger.mergeSequence" title="Permalink to this definition">¶</a></dt>
3556 <dd><p>Merge two sequences. The second sequence is unchanged,
3557 and the first is changed to have the elements of the second
3558 appended to it.</p>
3559 <p>&#64;param seq1: The sequence to merge into.
3560 &#64;type seq1: L{Sequence}.
3561 &#64;param seq2: The sequence to merge.
3562 &#64;type seq2: L{Sequence}.</p>
3563 </dd></dl>
3564
3565 <dl class="method">
3566 <dt id="src.pyconf.ConfigMerger.overwriteKeys">
3567 <code class="descname">overwriteKeys</code><span class="sig-paren">(</span><em>map1</em>, <em>seq2</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigMerger.overwriteKeys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigMerger.overwriteKeys" title="Permalink to this definition">¶</a></dt>
3568 <dd><p>Renint variables. The second mapping is unchanged,
3569 and the first is changed depending the keys of the second mapping.
3570 &#64;param map1: The mapping to reinit keys into.
3571 &#64;type map1: L{Mapping}.
3572 &#64;param map2: The mapping container reinit information.
3573 &#64;type map2: L{Mapping}.</p>
3574 </dd></dl>
3575
3576 </dd></dl>
3577
3578 <dl class="class">
3579 <dt id="src.pyconf.ConfigOutputStream">
3580 <em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigOutputStream</code><span class="sig-paren">(</span><em>stream</em>, <em>encoding=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigOutputStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigOutputStream" title="Permalink to this definition">¶</a></dt>
3581 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
3582 <p>An output stream which can write either ANSI files with default encoding
3583 or Unicode files with BOMs.</p>
3584 <p>Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
3585 built-in support.</p>
3586 <dl class="method">
3587 <dt id="src.pyconf.ConfigOutputStream.close">
3588 <code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigOutputStream.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigOutputStream.close" title="Permalink to this definition">¶</a></dt>
3589 <dd></dd></dl>
3590
3591 <dl class="method">
3592 <dt id="src.pyconf.ConfigOutputStream.flush">
3593 <code class="descname">flush</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigOutputStream.flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigOutputStream.flush" title="Permalink to this definition">¶</a></dt>
3594 <dd></dd></dl>
3595
3596 <dl class="method">
3597 <dt id="src.pyconf.ConfigOutputStream.write">
3598 <code class="descname">write</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigOutputStream.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigOutputStream.write" title="Permalink to this definition">¶</a></dt>
3599 <dd></dd></dl>
3600
3601 </dd></dl>
3602
3603 <dl class="class">
3604 <dt id="src.pyconf.ConfigReader">
3605 <em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigReader</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader" title="Permalink to this definition">¶</a></dt>
3606 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
3607 <p>This internal class implements a parser for configurations.</p>
3608 <dl class="method">
3609 <dt id="src.pyconf.ConfigReader.getChar">
3610 <code class="descname">getChar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.getChar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.getChar" title="Permalink to this definition">¶</a></dt>
3611 <dd><p>Get the next char from the stream. Update line and column numbers
3612 appropriately.</p>
3613 <p>&#64;return: The next character from the stream.
3614 &#64;rtype: str</p>
3615 </dd></dl>
3616
3617 <dl class="method">
3618 <dt id="src.pyconf.ConfigReader.getToken">
3619 <code class="descname">getToken</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.getToken"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.getToken" title="Permalink to this definition">¶</a></dt>
3620 <dd><p>Get a token from the stream. String values are returned in a form
3621 where you need to eval() the returned value to get the actual
3622 string. The return value is (token_type, token_value).</p>
3623 <p>Multiline string tokenizing is thanks to David Janes (BlogMatrix)</p>
3624 <p>&#64;return: The next token.
3625 &#64;rtype: A token tuple.</p>
3626 </dd></dl>
3627
3628 <dl class="method">
3629 <dt id="src.pyconf.ConfigReader.load">
3630 <code class="descname">load</code><span class="sig-paren">(</span><em>stream</em>, <em>parent=None</em>, <em>suffix=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.load"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.load" title="Permalink to this definition">¶</a></dt>
3631 <dd><p>Load the configuration from the specified stream.</p>
3632 <p>&#64;param stream: A stream from which to load the configuration.
3633 &#64;type stream: A stream (file-like object).
3634 &#64;param parent: The parent of the configuration (to which this reader
3635 belongs) in the hierarchy. Specified when the configuration is
3636 included in another one.
3637 &#64;type parent: A L{Container} instance.
3638 &#64;param suffix: The suffix of this configuration in the parent
3639 configuration. Should be specified whenever the parent is not None.
3640 &#64;raise ConfigError: If parent is specified but suffix is not.
3641 &#64;raise ConfigFormatError: If there are syntax errors in the stream.</p>
3642 </dd></dl>
3643
3644 <dl class="method">
3645 <dt id="src.pyconf.ConfigReader.location">
3646 <code class="descname">location</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.location"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.location" title="Permalink to this definition">¶</a></dt>
3647 <dd><p>Return the current location (filename, line, column) in the stream
3648 as a string.</p>
3649 <p>Used when printing error messages,</p>
3650 <p>&#64;return: A string representing a location in the stream being read.
3651 &#64;rtype: str</p>
3652 </dd></dl>
3653
3654 <dl class="method">
3655 <dt id="src.pyconf.ConfigReader.match">
3656 <code class="descname">match</code><span class="sig-paren">(</span><em>t</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.match"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.match" title="Permalink to this definition">¶</a></dt>
3657 <dd><p>Ensure that the current token type matches the specified value, and
3658 advance to the next token.</p>
3659 <p>&#64;param t: The token type to match.
3660 &#64;type t: A valid token type.
3661 &#64;return: The token which was last read from the stream before this
3662 function is called.
3663 &#64;rtype: a token tuple - see L{getToken}.
3664 &#64;raise ConfigFormatError: If the token does not match what’s expected.</p>
3665 </dd></dl>
3666
3667 <dl class="method">
3668 <dt id="src.pyconf.ConfigReader.parseFactor">
3669 <code class="descname">parseFactor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseFactor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseFactor" title="Permalink to this definition">¶</a></dt>
3670 <dd><p>Parse a factor in an multiplicative expression (a * b, a / b, a % b)</p>
3671 <p>&#64;return: the parsed factor
3672 &#64;rtype: any scalar
3673 &#64;raise ConfigFormatError: if a syntax error is found.</p>
3674 </dd></dl>
3675
3676 <dl class="method">
3677 <dt id="src.pyconf.ConfigReader.parseKeyValuePair">
3678 <code class="descname">parseKeyValuePair</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseKeyValuePair"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseKeyValuePair" title="Permalink to this definition">¶</a></dt>
3679 <dd><p>Parse a key-value pair, and add it to the provided L{Mapping}.</p>
3680 <p>&#64;param parent: The mapping to add entries to.
3681 &#64;type parent: A L{Mapping} instance.
3682 &#64;raise ConfigFormatError: if a syntax error is found.</p>
3683 </dd></dl>
3684
3685 <dl class="method">
3686 <dt id="src.pyconf.ConfigReader.parseMapping">
3687 <code class="descname">parseMapping</code><span class="sig-paren">(</span><em>parent</em>, <em>suffix</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseMapping"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseMapping" title="Permalink to this definition">¶</a></dt>
3688 <dd><p>Parse a mapping.</p>
3689 <p>&#64;param parent: The container to which the mapping will be added.
3690 &#64;type parent: A L{Container} instance.
3691 &#64;param suffix: The suffix for the value.
3692 &#64;type suffix: str
3693 &#64;return: a L{Mapping} instance representing the mapping.
3694 &#64;rtype: L{Mapping}
3695 &#64;raise ConfigFormatError: if a syntax error is found.</p>
3696 </dd></dl>
3697
3698 <dl class="method">
3699 <dt id="src.pyconf.ConfigReader.parseMappingBody">
3700 <code class="descname">parseMappingBody</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseMappingBody"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseMappingBody" title="Permalink to this definition">¶</a></dt>
3701 <dd><p>Parse the internals of a mapping, and add entries to the provided
3702 L{Mapping}.</p>
3703 <p>&#64;param parent: The mapping to add entries to.
3704 &#64;type parent: A L{Mapping} instance.</p>
3705 </dd></dl>
3706
3707 <dl class="method">
3708 <dt id="src.pyconf.ConfigReader.parseReference">
3709 <code class="descname">parseReference</code><span class="sig-paren">(</span><em>type</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseReference"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseReference" title="Permalink to this definition">¶</a></dt>
3710 <dd><p>Parse a reference.</p>
3711 <p>&#64;return: the parsed reference
3712 &#64;rtype: L{Reference}
3713 &#64;raise ConfigFormatError: if a syntax error is found.</p>
3714 </dd></dl>
3715
3716 <dl class="method">
3717 <dt id="src.pyconf.ConfigReader.parseScalar">
3718 <code class="descname">parseScalar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseScalar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseScalar" title="Permalink to this definition">¶</a></dt>
3719 <dd><p>Parse a scalar - a terminal value such as a string or number, or
3720 an L{Expression} or L{Reference}.</p>
3721 <p>&#64;return: the parsed scalar
3722 &#64;rtype: any scalar
3723 &#64;raise ConfigFormatError: if a syntax error is found.</p>
3724 </dd></dl>
3725
3726 <dl class="method">
3727 <dt id="src.pyconf.ConfigReader.parseSequence">
3728 <code class="descname">parseSequence</code><span class="sig-paren">(</span><em>parent</em>, <em>suffix</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseSequence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseSequence" title="Permalink to this definition">¶</a></dt>
3729 <dd><p>Parse a sequence.</p>
3730 <p>&#64;param parent: The container to which the sequence will be added.
3731 &#64;type parent: A L{Container} instance.
3732 &#64;param suffix: The suffix for the value.
3733 &#64;type suffix: str
3734 &#64;return: a L{Sequence} instance representing the sequence.
3735 &#64;rtype: L{Sequence}
3736 &#64;raise ConfigFormatError: if a syntax error is found.</p>
3737 </dd></dl>
3738
3739 <dl class="method">
3740 <dt id="src.pyconf.ConfigReader.parseSuffix">
3741 <code class="descname">parseSuffix</code><span class="sig-paren">(</span><em>ref</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseSuffix"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseSuffix" title="Permalink to this definition">¶</a></dt>
3742 <dd><p>Parse a reference suffix.</p>
3743 <p>&#64;param ref: The reference of which this suffix is a part.
3744 &#64;type ref: L{Reference}.
3745 &#64;raise ConfigFormatError: if a syntax error is found.</p>
3746 </dd></dl>
3747
3748 <dl class="method">
3749 <dt id="src.pyconf.ConfigReader.parseTerm">
3750 <code class="descname">parseTerm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseTerm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseTerm" title="Permalink to this definition">¶</a></dt>
3751 <dd><p>Parse a term in an additive expression (a + b, a - b)</p>
3752 <p>&#64;return: the parsed term
3753 &#64;rtype: any scalar
3754 &#64;raise ConfigFormatError: if a syntax error is found.</p>
3755 </dd></dl>
3756
3757 <dl class="method">
3758 <dt id="src.pyconf.ConfigReader.parseValue">
3759 <code class="descname">parseValue</code><span class="sig-paren">(</span><em>parent</em>, <em>suffix</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.parseValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.parseValue" title="Permalink to this definition">¶</a></dt>
3760 <dd><p>Parse a value.</p>
3761 <p>&#64;param parent: The container to which the value will be added.
3762 &#64;type parent: A L{Container} instance.
3763 &#64;param suffix: The suffix for the value.
3764 &#64;type suffix: str
3765 &#64;return: The value
3766 &#64;rtype: any
3767 &#64;raise ConfigFormatError: if a syntax error is found.</p>
3768 </dd></dl>
3769
3770 <dl class="method">
3771 <dt id="src.pyconf.ConfigReader.setStream">
3772 <code class="descname">setStream</code><span class="sig-paren">(</span><em>stream</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigReader.setStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigReader.setStream" title="Permalink to this definition">¶</a></dt>
3773 <dd><p>Set the stream to the specified value, and prepare to read from it.</p>
3774 <p>&#64;param stream: A stream from which to load the configuration.
3775 &#64;type stream: A stream (file-like object).</p>
3776 </dd></dl>
3777
3778 </dd></dl>
3779
3780 <dl class="exception">
3781 <dt id="src.pyconf.ConfigResolutionError">
3782 <em class="property">exception </em><code class="descclassname">src.pyconf.</code><code class="descname">ConfigResolutionError</code><a class="reference internal" href="../../_modules/src/pyconf.html#ConfigResolutionError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.ConfigResolutionError" title="Permalink to this definition">¶</a></dt>
3783 <dd><p>Bases: <a class="reference internal" href="#src.pyconf.ConfigError" title="src.pyconf.ConfigError"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.pyconf.ConfigError</span></code></a></p>
3784 <p>This is the base class of exceptions raised due to semantic errors in
3785 configurations.</p>
3786 </dd></dl>
3787
3788 <dl class="class">
3789 <dt id="src.pyconf.Container">
3790 <em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">Container</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Container"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Container" title="Permalink to this definition">¶</a></dt>
3791 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
3792 <p>This internal class is the base class for mappings and sequences.</p>
3793 <p>&#64;ivar path: A string which describes how to get
3794 to this instance from the root of the hierarchy.</p>
3795 <p>Example:</p>
3796 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">a</span><span class="o">.</span><span class="n">list</span><span class="o">.</span><span class="n">of</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="ow">or</span><span class="p">[</span><span class="s1">&#39;more&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">elements</span>
3797 </pre></div>
3798 </div>
3799 <dl class="method">
3800 <dt id="src.pyconf.Container.evaluate">
3801 <code class="descname">evaluate</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Container.evaluate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Container.evaluate" title="Permalink to this definition">¶</a></dt>
3802 <dd><p>Evaluate items which are instances of L{Reference} or L{Expression}.</p>
3803 <p>L{Reference} instances are evaluated using L{Reference.resolve},
3804 and L{Expression} instances are evaluated using
3805 L{Expression.evaluate}.</p>
3806 <p>&#64;param item: The item to be evaluated.
3807 &#64;type item: any
3808 &#64;return: If the item is an instance of L{Reference} or L{Expression},
3809 the evaluated value is returned, otherwise the item is returned
3810 unchanged.</p>
3811 </dd></dl>
3812
3813 <dl class="method">
3814 <dt id="src.pyconf.Container.setPath">
3815 <code class="descname">setPath</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Container.setPath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Container.setPath" title="Permalink to this definition">¶</a></dt>
3816 <dd><p>Set the path for this instance.
3817 &#64;param path: The path - a string which describes how to get
3818 to this instance from the root of the hierarchy.
3819 &#64;type path: str</p>
3820 </dd></dl>
3821
3822 <dl class="method">
3823 <dt id="src.pyconf.Container.writeToStream">
3824 <code class="descname">writeToStream</code><span class="sig-paren">(</span><em>stream</em>, <em>indent</em>, <em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Container.writeToStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Container.writeToStream" title="Permalink to this definition">¶</a></dt>
3825 <dd><p>Write this instance to a stream at the specified indentation level.</p>
3826 <p>Should be redefined in subclasses.</p>
3827 <p>&#64;param stream: The stream to write to
3828 &#64;type stream: A writable stream (file-like object)
3829 &#64;param indent: The indentation level
3830 &#64;type indent: int
3831 &#64;param container: The container of this instance
3832 &#64;type container: L{Container}
3833 &#64;raise NotImplementedError: If a subclass does not override this</p>
3834 </dd></dl>
3835
3836 <dl class="method">
3837 <dt id="src.pyconf.Container.writeValue">
3838 <code class="descname">writeValue</code><span class="sig-paren">(</span><em>value</em>, <em>stream</em>, <em>indent</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Container.writeValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Container.writeValue" title="Permalink to this definition">¶</a></dt>
3839 <dd></dd></dl>
3840
3841 </dd></dl>
3842
3843 <dl class="class">
3844 <dt id="src.pyconf.Expression">
3845 <em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">Expression</code><span class="sig-paren">(</span><em>op</em>, <em>lhs</em>, <em>rhs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Expression"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Expression" title="Permalink to this definition">¶</a></dt>
3846 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
3847 <p>This internal class implements a value which is obtained by evaluating an expression.</p>
3848 <dl class="method">
3849 <dt id="src.pyconf.Expression.evaluate">
3850 <code class="descname">evaluate</code><span class="sig-paren">(</span><em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Expression.evaluate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Expression.evaluate" title="Permalink to this definition">¶</a></dt>
3851 <dd><p>Evaluate this instance in the context of a container.</p>
3852 <p>&#64;param container: The container to evaluate in from.
3853 &#64;type container: L{Container}
3854 &#64;return: The evaluated value.
3855 &#64;rtype: any
3856 &#64;raise ConfigResolutionError: If evaluation fails.
3857 &#64;raise ZeroDivideError: If division by zero occurs.
3858 &#64;raise TypeError: If the operation is invalid, e.g.
3859 subtracting one string from another.</p>
3860 </dd></dl>
3861
3862 </dd></dl>
3863
3864 <dl class="class">
3865 <dt id="src.pyconf.Mapping">
3866 <em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">Mapping</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping" title="Permalink to this definition">¶</a></dt>
3867 <dd><p>Bases: <a class="reference internal" href="#src.pyconf.Container" title="src.pyconf.Container"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.pyconf.Container</span></code></a></p>
3868 <p>This internal class implements key-value mappings in configurations.</p>
3869 <dl class="method">
3870 <dt id="src.pyconf.Mapping.addMapping">
3871 <code class="descname">addMapping</code><span class="sig-paren">(</span><em>key</em>, <em>value</em>, <em>comment</em>, <em>setting=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping.addMapping"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping.addMapping" title="Permalink to this definition">¶</a></dt>
3872 <dd><p>Add a key-value mapping with a comment.</p>
3873 <p>&#64;param key: The key for the mapping.
3874 &#64;type key: str
3875 &#64;param value: The value for the mapping.
3876 &#64;type value: any
3877 &#64;param comment: The comment for the key (can be None).
3878 &#64;type comment: str
3879 &#64;param setting: If True, ignore clashes. This is set
3880 to true when called from L{__setattr__}.
3881 &#64;raise ConfigFormatError: If an existing key is seen
3882 again and setting is False.</p>
3883 </dd></dl>
3884
3885 <dl class="method">
3886 <dt id="src.pyconf.Mapping.get">
3887 <code class="descname">get</code><span class="sig-paren">(</span><em>key</em>, <em>default=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping.get" title="Permalink to this definition">¶</a></dt>
3888 <dd><p>Allows a dictionary-style get operation.</p>
3889 </dd></dl>
3890
3891 <dl class="method">
3892 <dt id="src.pyconf.Mapping.iteritems">
3893 <code class="descname">iteritems</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping.iteritems"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping.iteritems" title="Permalink to this definition">¶</a></dt>
3894 <dd></dd></dl>
3895
3896 <dl class="method">
3897 <dt id="src.pyconf.Mapping.iterkeys">
3898 <code class="descname">iterkeys</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping.iterkeys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping.iterkeys" title="Permalink to this definition">¶</a></dt>
3899 <dd></dd></dl>
3900
3901 <dl class="method">
3902 <dt id="src.pyconf.Mapping.keys">
3903 <code class="descname">keys</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping.keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping.keys" title="Permalink to this definition">¶</a></dt>
3904 <dd><p>Return the keys in a similar way to a dictionary.</p>
3905 </dd></dl>
3906
3907 <dl class="method">
3908 <dt id="src.pyconf.Mapping.writeToStream">
3909 <code class="descname">writeToStream</code><span class="sig-paren">(</span><em>stream</em>, <em>indent</em>, <em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Mapping.writeToStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Mapping.writeToStream" title="Permalink to this definition">¶</a></dt>
3910 <dd><p>Write this instance to a stream at the specified indentation level.</p>
3911 <p>Should be redefined in subclasses.</p>
3912 <p>&#64;param stream: The stream to write to
3913 &#64;type stream: A writable stream (file-like object)
3914 &#64;param indent: The indentation level
3915 &#64;type indent: int
3916 &#64;param container: The container of this instance
3917 &#64;type container: L{Container}</p>
3918 </dd></dl>
3919
3920 </dd></dl>
3921
3922 <dl class="class">
3923 <dt id="src.pyconf.Reference">
3924 <em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">Reference</code><span class="sig-paren">(</span><em>config</em>, <em>type</em>, <em>ident</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Reference"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Reference" title="Permalink to this definition">¶</a></dt>
3925 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
3926 <p>This internal class implements a value which is a reference to another value.</p>
3927 <dl class="method">
3928 <dt id="src.pyconf.Reference.addElement">
3929 <code class="descname">addElement</code><span class="sig-paren">(</span><em>type</em>, <em>ident</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Reference.addElement"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Reference.addElement" title="Permalink to this definition">¶</a></dt>
3930 <dd><p>Add an element to the reference.</p>
3931 <p>&#64;param type: The type of reference.
3932 &#64;type type: BACKTICK or DOLLAR
3933 &#64;param ident: The identifier which continues the reference.
3934 &#64;type ident: str</p>
3935 </dd></dl>
3936
3937 <dl class="method">
3938 <dt id="src.pyconf.Reference.findConfig">
3939 <code class="descname">findConfig</code><span class="sig-paren">(</span><em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Reference.findConfig"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Reference.findConfig" title="Permalink to this definition">¶</a></dt>
3940 <dd><p>Find the closest enclosing configuration to the specified container.</p>
3941 <p>&#64;param container: The container to start from.
3942 &#64;type container: L{Container}
3943 &#64;return: The closest enclosing configuration, or None.
3944 &#64;rtype: L{Config}</p>
3945 </dd></dl>
3946
3947 <dl class="method">
3948 <dt id="src.pyconf.Reference.resolve">
3949 <code class="descname">resolve</code><span class="sig-paren">(</span><em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Reference.resolve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Reference.resolve" title="Permalink to this definition">¶</a></dt>
3950 <dd><p>Resolve this instance in the context of a container.</p>
3951 <p>&#64;param container: The container to resolve from.
3952 &#64;type container: L{Container}
3953 &#64;return: The resolved value.
3954 &#64;rtype: any
3955 &#64;raise ConfigResolutionError: If resolution fails.</p>
3956 </dd></dl>
3957
3958 </dd></dl>
3959
3960 <dl class="class">
3961 <dt id="src.pyconf.Sequence">
3962 <em class="property">class </em><code class="descclassname">src.pyconf.</code><code class="descname">Sequence</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Sequence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Sequence" title="Permalink to this definition">¶</a></dt>
3963 <dd><p>Bases: <a class="reference internal" href="#src.pyconf.Container" title="src.pyconf.Container"><code class="xref py py-class docutils literal notranslate"><span class="pre">src.pyconf.Container</span></code></a></p>
3964 <p>This internal class implements a value which is a sequence of other values.</p>
3965 <dl class="class">
3966 <dt id="src.pyconf.Sequence.SeqIter">
3967 <em class="property">class </em><code class="descname">SeqIter</code><span class="sig-paren">(</span><em>seq</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Sequence.SeqIter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Sequence.SeqIter" title="Permalink to this definition">¶</a></dt>
3968 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
3969 <p>This internal class implements an iterator for a L{Sequence} instance.</p>
3970 <dl class="method">
3971 <dt id="src.pyconf.Sequence.SeqIter.next">
3972 <code class="descname">next</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Sequence.SeqIter.next"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Sequence.SeqIter.next" title="Permalink to this definition">¶</a></dt>
3973 <dd></dd></dl>
3974
3975 </dd></dl>
3976
3977 <dl class="method">
3978 <dt id="src.pyconf.Sequence.append">
3979 <code class="descname">append</code><span class="sig-paren">(</span><em>item</em>, <em>comment</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Sequence.append"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Sequence.append" title="Permalink to this definition">¶</a></dt>
3980 <dd><p>Add an item to the sequence.</p>
3981 <p>&#64;param item: The item to add.
3982 &#64;type item: any
3983 &#64;param comment: A comment for the item.
3984 &#64;type comment: str</p>
3985 </dd></dl>
3986
3987 <dl class="method">
3988 <dt id="src.pyconf.Sequence.writeToStream">
3989 <code class="descname">writeToStream</code><span class="sig-paren">(</span><em>stream</em>, <em>indent</em>, <em>container</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#Sequence.writeToStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.Sequence.writeToStream" title="Permalink to this definition">¶</a></dt>
3990 <dd><p>Write this instance to a stream at the specified indentation level.</p>
3991 <p>Should be redefined in subclasses.</p>
3992 <p>&#64;param stream: The stream to write to
3993 &#64;type stream: A writable stream (file-like object)
3994 &#64;param indent: The indentation level
3995 &#64;type indent: int
3996 &#64;param container: The container of this instance
3997 &#64;type container: L{Container}</p>
3998 </dd></dl>
3999
4000 </dd></dl>
4001
4002 <dl class="function">
4003 <dt id="src.pyconf.deepCopyMapping">
4004 <code class="descclassname">src.pyconf.</code><code class="descname">deepCopyMapping</code><span class="sig-paren">(</span><em>inMapping</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#deepCopyMapping"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.deepCopyMapping" title="Permalink to this definition">¶</a></dt>
4005 <dd></dd></dl>
4006
4007 <dl class="function">
4008 <dt id="src.pyconf.defaultMergeResolve">
4009 <code class="descclassname">src.pyconf.</code><code class="descname">defaultMergeResolve</code><span class="sig-paren">(</span><em>map1</em>, <em>map2</em>, <em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#defaultMergeResolve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.defaultMergeResolve" title="Permalink to this definition">¶</a></dt>
4010 <dd><p>A default resolver for merge conflicts.
4011 Returns a string indicating what action to take to resolve the conflict.</p>
4012 <p>&#64;param map1: The map being merged into.
4013 &#64;type map1: L{Mapping}.
4014 &#64;param map2: The map being used as the merge operand.
4015 &#64;type map2: L{Mapping}.
4016 &#64;param key: The key in map2 (which also exists in map1).
4017 &#64;type key: str</p>
4018 <dl class="docutils">
4019 <dt>&#64;return: One of “merge”, “append”, “mismatch” or “overwrite”</dt>
4020 <dd>indicating what action should be taken. This should
4021 be appropriate to the objects being merged - e.g.
4022 there is no point returning “merge” if the two objects
4023 are instances of L{Sequence}.</dd>
4024 </dl>
4025 <p>&#64;rtype: str</p>
4026 </dd></dl>
4027
4028 <dl class="function">
4029 <dt id="src.pyconf.defaultStreamOpener">
4030 <code class="descclassname">src.pyconf.</code><code class="descname">defaultStreamOpener</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#defaultStreamOpener"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.defaultStreamOpener" title="Permalink to this definition">¶</a></dt>
4031 <dd><p>This function returns a read-only stream, given its name. The name passed
4032 in should correspond to an existing stream, otherwise an exception will be
4033 raised.</p>
4034 <p>This is the default value of L{streamOpener}; assign your own callable to
4035 streamOpener to return streams based on names. For example, you could use
4036 urllib2.urlopen().</p>
4037 <p>&#64;param name: The name of a stream, most commonly a file name.
4038 &#64;type name: str
4039 &#64;return: A stream with the specified name.
4040 &#64;rtype: A read-only stream (file-like object)</p>
4041 </dd></dl>
4042
4043 <dl class="function">
4044 <dt id="src.pyconf.isWord">
4045 <code class="descclassname">src.pyconf.</code><code class="descname">isWord</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#isWord"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.isWord" title="Permalink to this definition">¶</a></dt>
4046 <dd><p>See if a passed-in value is an identifier. If the value passed in is not a
4047 string, False is returned. An identifier consists of alphanumerics or
4048 underscore characters.</p>
4049 <p>Examples:</p>
4050 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">isWord</span><span class="p">(</span><span class="s1">&#39;a word&#39;</span><span class="p">)</span> <span class="o">-&gt;</span><span class="kc">False</span>
4051 <span class="n">isWord</span><span class="p">(</span><span class="s1">&#39;award&#39;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">True</span>
4052 <span class="n">isWord</span><span class="p">(</span><span class="mi">9</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">False</span>
4053 <span class="n">isWord</span><span class="p">(</span><span class="s1">&#39;a_b_c_&#39;</span><span class="p">)</span> <span class="o">-&gt;</span><span class="kc">True</span>
4054 </pre></div>
4055 </div>
4056 <p>&#64;note: isWord(‘9abc’) will return True - not exactly correct, but adequate
4057 for the way it’s used here.</p>
4058 <p>&#64;param s: The name to be tested
4059 &#64;type s: any
4060 &#64;return: True if a word, else False
4061 &#64;rtype: bool</p>
4062 </dd></dl>
4063
4064 <dl class="function">
4065 <dt id="src.pyconf.makePath">
4066 <code class="descclassname">src.pyconf.</code><code class="descname">makePath</code><span class="sig-paren">(</span><em>prefix</em>, <em>suffix</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#makePath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.makePath" title="Permalink to this definition">¶</a></dt>
4067 <dd><p>Make a path from a prefix and suffix.</p>
4068 <p>Examples:
4069 makePath(‘’, ‘suffix’) -&gt; ‘suffix’
4070 makePath(‘prefix’, ‘suffix’) -&gt; ‘prefix.suffix’
4071 makePath(‘prefix’, ‘[1]’) -&gt; ‘prefix[1]’</p>
4072 <p>&#64;param prefix: The prefix to use. If it evaluates as false, the suffix is returned.
4073 &#64;type prefix: str
4074 &#64;param suffix: The suffix to use. It is either an identifier or an index in brackets.
4075 &#64;type suffix: str
4076 &#64;return: The path concatenation of prefix and suffix, with adot if the suffix is not a bracketed index.
4077 &#64;rtype: str</p>
4078 </dd></dl>
4079
4080 <dl class="function">
4081 <dt id="src.pyconf.overwriteMergeResolve">
4082 <code class="descclassname">src.pyconf.</code><code class="descname">overwriteMergeResolve</code><span class="sig-paren">(</span><em>map1</em>, <em>map2</em>, <em>key</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/pyconf.html#overwriteMergeResolve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.pyconf.overwriteMergeResolve" title="Permalink to this definition">¶</a></dt>
4083 <dd><p>An overwriting resolver for merge conflicts. Calls L{defaultMergeResolve},
4084 but where a “mismatch” is detected, returns “overwrite” instead.</p>
4085 <p>&#64;param map1: The map being merged into.
4086 &#64;type map1: L{Mapping}.
4087 &#64;param map2: The map being used as the merge operand.
4088 &#64;type map2: L{Mapping}.
4089 &#64;param key: The key in map2 (which also exists in map1).
4090 &#64;type key: str</p>
4091 </dd></dl>
4092
4093 </div>
4094 <div class="section" id="module-src.system">
4095 <span id="src-system-module"></span><h2>src.system module<a class="headerlink" href="#module-src.system" title="Permalink to this headline">¶</a></h2>
4096 <p>In this file : all functions that do a system call,
4097 like open a browser or an editor, or call a git command</p>
4098 <dl class="function">
4099 <dt id="src.system.archive_extract">
4100 <code class="descclassname">src.system.</code><code class="descname">archive_extract</code><span class="sig-paren">(</span><em>from_what</em>, <em>where</em>, <em>logger</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/system.html#archive_extract"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.system.archive_extract" title="Permalink to this definition">¶</a></dt>
4101 <dd><p>Extracts sources from an archive.</p>
4102 <table class="docutils field-list" frame="void" rules="none">
4103 <col class="field-name" />
4104 <col class="field-body" />
4105 <tbody valign="top">
4106 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
4107 <li><strong>str</strong> (<em>where</em>) – The path to the archive.</li>
4108 <li><strong>str</strong> – The path where to extract.</li>
4109 <li><strong>Logger</strong> (<em>logger</em>) – The logger instance to use.</li>
4110 </ul>
4111 </td>
4112 </tr>
4113 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the extraction is successful</p>
4114 </td>
4115 </tr>
4116 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">boolean</p>
4117 </td>
4118 </tr>
4119 </tbody>
4120 </table>
4121 </dd></dl>
4122
4123 <dl class="function">
4124 <dt id="src.system.cvs_extract">
4125 <code class="descclassname">src.system.</code><code class="descname">cvs_extract</code><span class="sig-paren">(</span><em>protocol</em>, <em>user</em>, <em>server</em>, <em>base</em>, <em>tag</em>, <em>product</em>, <em>where</em>, <em>logger</em>, <em>checkout=False</em>, <em>environment=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/system.html#cvs_extract"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.system.cvs_extract" title="Permalink to this definition">¶</a></dt>
4126 <dd><p>Extracts sources from a cvs repository.</p>
4127 <table class="docutils field-list" frame="void" rules="none">
4128 <col class="field-name" />
4129 <col class="field-body" />
4130 <tbody valign="top">
4131 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
4132 <li><strong>str</strong> (<em>where</em>) – The cvs protocol.</li>
4133 <li><strong>str</strong> – The user to be used.</li>
4134 <li><strong>str</strong> – The remote cvs server.</li>
4135 <li><strong>str</strong> – <p>.</p>
4136 </li>
4137 <li><strong>str</strong> – The tag.</li>
4138 <li><strong>str</strong> – The product.</li>
4139 <li><strong>str</strong> – The path where to extract.</li>
4140 <li><strong>Logger</strong> (<em>logger</em>) – The logger instance to use.</li>
4141 <li><strong>boolean</strong> (<em>checkout</em>) – If true use checkout cvs.</li>
4142 <li><strong>src.environment.Environ</strong> (<em>environment</em>) – The environment to source when
4143 extracting.</li>
4144 </ul>
4145 </td>
4146 </tr>
4147 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the extraction is successful</p>
4148 </td>
4149 </tr>
4150 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">boolean</p>
4151 </td>
4152 </tr>
4153 </tbody>
4154 </table>
4155 </dd></dl>
4156
4157 <dl class="function">
4158 <dt id="src.system.git_extract">
4159 <code class="descclassname">src.system.</code><code class="descname">git_extract</code><span class="sig-paren">(</span><em>from_what</em>, <em>tag</em>, <em>where</em>, <em>logger</em>, <em>environment=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/system.html#git_extract"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.system.git_extract" title="Permalink to this definition">¶</a></dt>
4160 <dd><p>Extracts sources from a git repository.</p>
4161 <table class="docutils field-list" frame="void" rules="none">
4162 <col class="field-name" />
4163 <col class="field-body" />
4164 <tbody valign="top">
4165 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
4166 <li><strong>str</strong> (<em>where</em>) – The remote git repository.</li>
4167 <li><strong>str</strong> – The tag.</li>
4168 <li><strong>str</strong> – The path where to extract.</li>
4169 <li><strong>Logger</strong> (<em>logger</em>) – The logger instance to use.</li>
4170 <li><strong>src.environment.Environ</strong> (<em>environment</em>) – The environment to source when
4171 extracting.</li>
4172 </ul>
4173 </td>
4174 </tr>
4175 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the extraction is successful</p>
4176 </td>
4177 </tr>
4178 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">boolean</p>
4179 </td>
4180 </tr>
4181 </tbody>
4182 </table>
4183 </dd></dl>
4184
4185 <dl class="function">
4186 <dt id="src.system.show_in_editor">
4187 <code class="descclassname">src.system.</code><code class="descname">show_in_editor</code><span class="sig-paren">(</span><em>editor</em>, <em>filePath</em>, <em>logger</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/system.html#show_in_editor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.system.show_in_editor" title="Permalink to this definition">¶</a></dt>
4188 <dd><p>open filePath using editor.</p>
4189 <table class="docutils field-list" frame="void" rules="none">
4190 <col class="field-name" />
4191 <col class="field-body" />
4192 <tbody valign="top">
4193 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
4194 <li><strong>str</strong> (<em>filePath</em>) – The editor to use.</li>
4195 <li><strong>str</strong> – The path to the file to open.</li>
4196 </ul>
4197 </td>
4198 </tr>
4199 </tbody>
4200 </table>
4201 </dd></dl>
4202
4203 <dl class="function">
4204 <dt id="src.system.svn_extract">
4205 <code class="descclassname">src.system.</code><code class="descname">svn_extract</code><span class="sig-paren">(</span><em>user</em>, <em>from_what</em>, <em>tag</em>, <em>where</em>, <em>logger</em>, <em>checkout=False</em>, <em>environment=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/system.html#svn_extract"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.system.svn_extract" title="Permalink to this definition">¶</a></dt>
4206 <dd><p>Extracts sources from a svn repository.</p>
4207 <table class="docutils field-list" frame="void" rules="none">
4208 <col class="field-name" />
4209 <col class="field-body" />
4210 <tbody valign="top">
4211 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
4212 <li><strong>str</strong> (<em>where</em>) – The user to be used.</li>
4213 <li><strong>str</strong> – The remote git repository.</li>
4214 <li><strong>str</strong> – The tag.</li>
4215 <li><strong>str</strong> – The path where to extract.</li>
4216 <li><strong>Logger</strong> (<em>logger</em>) – The logger instance to use.</li>
4217 <li><strong>boolean</strong> (<em>checkout</em>) – If true use checkout svn.</li>
4218 <li><strong>src.environment.Environ</strong> (<em>environment</em>) – The environment to source when
4219 extracting.</li>
4220 </ul>
4221 </td>
4222 </tr>
4223 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the extraction is successful</p>
4224 </td>
4225 </tr>
4226 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">boolean</p>
4227 </td>
4228 </tr>
4229 </tbody>
4230 </table>
4231 </dd></dl>
4232
4233 </div>
4234 <div class="section" id="module-src.template">
4235 <span id="src-template-module"></span><h2>src.template module<a class="headerlink" href="#module-src.template" title="Permalink to this headline">¶</a></h2>
4236 <dl class="class">
4237 <dt id="src.template.MyTemplate">
4238 <em class="property">class </em><code class="descclassname">src.template.</code><code class="descname">MyTemplate</code><span class="sig-paren">(</span><em>template</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/template.html#MyTemplate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.template.MyTemplate" title="Permalink to this definition">¶</a></dt>
4239 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">string.Template</span></code></p>
4240 <dl class="attribute">
4241 <dt id="src.template.MyTemplate.delimiter">
4242 <code class="descname">delimiter</code><em class="property"> = '\xc2\xa4'</em><a class="headerlink" href="#src.template.MyTemplate.delimiter" title="Permalink to this definition">¶</a></dt>
4243 <dd></dd></dl>
4244
4245 <dl class="attribute">
4246 <dt id="src.template.MyTemplate.pattern">
4247 <code class="descname">pattern</code><em class="property"> = &lt;_sre.SRE_Pattern object&gt;</em><a class="headerlink" href="#src.template.MyTemplate.pattern" title="Permalink to this definition">¶</a></dt>
4248 <dd></dd></dl>
4249
4250 </dd></dl>
4251
4252 <dl class="function">
4253 <dt id="src.template.substitute">
4254 <code class="descclassname">src.template.</code><code class="descname">substitute</code><span class="sig-paren">(</span><em>template_file</em>, <em>subst_dic</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/template.html#substitute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.template.substitute" title="Permalink to this definition">¶</a></dt>
4255 <dd></dd></dl>
4256
4257 </div>
4258 <div class="section" id="module-src.test_module">
4259 <span id="src-test-module-module"></span><h2>src.test_module module<a class="headerlink" href="#module-src.test_module" title="Permalink to this headline">¶</a></h2>
4260 <dl class="class">
4261 <dt id="src.test_module.Test">
4262 <em class="property">class </em><code class="descclassname">src.test_module.</code><code class="descname">Test</code><span class="sig-paren">(</span><em>config</em>, <em>logger</em>, <em>tmp_working_dir</em>, <em>testbase=''</em>, <em>grids=None</em>, <em>sessions=None</em>, <em>launcher=''</em>, <em>show_desktop=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test" title="Permalink to this definition">¶</a></dt>
4263 <dd><dl class="method">
4264 <dt id="src.test_module.Test.generate_launching_commands">
4265 <code class="descname">generate_launching_commands</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.generate_launching_commands"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.generate_launching_commands" title="Permalink to this definition">¶</a></dt>
4266 <dd></dd></dl>
4267
4268 <dl class="method">
4269 <dt id="src.test_module.Test.generate_script">
4270 <code class="descname">generate_script</code><span class="sig-paren">(</span><em>listTest</em>, <em>script_path</em>, <em>ignoreList</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.generate_script"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.generate_script" title="Permalink to this definition">¶</a></dt>
4271 <dd></dd></dl>
4272
4273 <dl class="method">
4274 <dt id="src.test_module.Test.get_test_timeout">
4275 <code class="descname">get_test_timeout</code><span class="sig-paren">(</span><em>test_name</em>, <em>default_value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.get_test_timeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.get_test_timeout" title="Permalink to this definition">¶</a></dt>
4276 <dd></dd></dl>
4277
4278 <dl class="method">
4279 <dt id="src.test_module.Test.get_tmp_dir">
4280 <code class="descname">get_tmp_dir</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.get_tmp_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.get_tmp_dir" title="Permalink to this definition">¶</a></dt>
4281 <dd></dd></dl>
4282
4283 <dl class="method">
4284 <dt id="src.test_module.Test.prepare_testbase">
4285 <code class="descname">prepare_testbase</code><span class="sig-paren">(</span><em>test_base_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.prepare_testbase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.prepare_testbase" title="Permalink to this definition">¶</a></dt>
4286 <dd></dd></dl>
4287
4288 <dl class="method">
4289 <dt id="src.test_module.Test.prepare_testbase_from_dir">
4290 <code class="descname">prepare_testbase_from_dir</code><span class="sig-paren">(</span><em>testbase_name</em>, <em>testbase_dir</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.prepare_testbase_from_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.prepare_testbase_from_dir" title="Permalink to this definition">¶</a></dt>
4291 <dd></dd></dl>
4292
4293 <dl class="method">
4294 <dt id="src.test_module.Test.prepare_testbase_from_git">
4295 <code class="descname">prepare_testbase_from_git</code><span class="sig-paren">(</span><em>testbase_name</em>, <em>testbase_base</em>, <em>testbase_tag</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.prepare_testbase_from_git"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.prepare_testbase_from_git" title="Permalink to this definition">¶</a></dt>
4296 <dd></dd></dl>
4297
4298 <dl class="method">
4299 <dt id="src.test_module.Test.prepare_testbase_from_svn">
4300 <code class="descname">prepare_testbase_from_svn</code><span class="sig-paren">(</span><em>user</em>, <em>testbase_name</em>, <em>testbase_base</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.prepare_testbase_from_svn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.prepare_testbase_from_svn" title="Permalink to this definition">¶</a></dt>
4301 <dd></dd></dl>
4302
4303 <dl class="method">
4304 <dt id="src.test_module.Test.read_results">
4305 <code class="descname">read_results</code><span class="sig-paren">(</span><em>listTest</em>, <em>has_timed_out</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.read_results"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.read_results" title="Permalink to this definition">¶</a></dt>
4306 <dd></dd></dl>
4307
4308 <dl class="method">
4309 <dt id="src.test_module.Test.run_all_tests">
4310 <code class="descname">run_all_tests</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.run_all_tests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.run_all_tests" title="Permalink to this definition">¶</a></dt>
4311 <dd></dd></dl>
4312
4313 <dl class="method">
4314 <dt id="src.test_module.Test.run_grid_tests">
4315 <code class="descname">run_grid_tests</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.run_grid_tests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.run_grid_tests" title="Permalink to this definition">¶</a></dt>
4316 <dd></dd></dl>
4317
4318 <dl class="method">
4319 <dt id="src.test_module.Test.run_script">
4320 <code class="descname">run_script</code><span class="sig-paren">(</span><em>script_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.run_script"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.run_script" title="Permalink to this definition">¶</a></dt>
4321 <dd></dd></dl>
4322
4323 <dl class="method">
4324 <dt id="src.test_module.Test.run_session_tests">
4325 <code class="descname">run_session_tests</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.run_session_tests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.run_session_tests" title="Permalink to this definition">¶</a></dt>
4326 <dd></dd></dl>
4327
4328 <dl class="method">
4329 <dt id="src.test_module.Test.run_testbase_tests">
4330 <code class="descname">run_testbase_tests</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.run_testbase_tests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.run_testbase_tests" title="Permalink to this definition">¶</a></dt>
4331 <dd></dd></dl>
4332
4333 <dl class="method">
4334 <dt id="src.test_module.Test.run_tests">
4335 <code class="descname">run_tests</code><span class="sig-paren">(</span><em>listTest</em>, <em>ignoreList</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.run_tests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.run_tests" title="Permalink to this definition">¶</a></dt>
4336 <dd></dd></dl>
4337
4338 <dl class="method">
4339 <dt id="src.test_module.Test.search_known_errors">
4340 <code class="descname">search_known_errors</code><span class="sig-paren">(</span><em>status</em>, <em>test_grid</em>, <em>test_session</em>, <em>test</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.search_known_errors"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.search_known_errors" title="Permalink to this definition">¶</a></dt>
4341 <dd></dd></dl>
4342
4343 <dl class="method">
4344 <dt id="src.test_module.Test.write_test_margin">
4345 <code class="descname">write_test_margin</code><span class="sig-paren">(</span><em>tab</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#Test.write_test_margin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.Test.write_test_margin" title="Permalink to this definition">¶</a></dt>
4346 <dd></dd></dl>
4347
4348 </dd></dl>
4349
4350 <dl class="function">
4351 <dt id="src.test_module.getTmpDirDEFAULT">
4352 <code class="descclassname">src.test_module.</code><code class="descname">getTmpDirDEFAULT</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/test_module.html#getTmpDirDEFAULT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.test_module.getTmpDirDEFAULT" title="Permalink to this definition">¶</a></dt>
4353 <dd></dd></dl>
4354
4355 </div>
4356 <div class="section" id="module-src.xmlManager">
4357 <span id="src-xmlmanager-module"></span><h2>src.xmlManager module<a class="headerlink" href="#module-src.xmlManager" title="Permalink to this headline">¶</a></h2>
4358 <dl class="class">
4359 <dt id="src.xmlManager.ReadXmlFile">
4360 <em class="property">class </em><code class="descclassname">src.xmlManager.</code><code class="descname">ReadXmlFile</code><span class="sig-paren">(</span><em>filePath</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#ReadXmlFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.ReadXmlFile" title="Permalink to this definition">¶</a></dt>
4361 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
4362 <p>Class to manage reading of an xml log file</p>
4363 <dl class="method">
4364 <dt id="src.xmlManager.ReadXmlFile.getRootAttrib">
4365 <code class="descname">getRootAttrib</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#ReadXmlFile.getRootAttrib"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.ReadXmlFile.getRootAttrib" title="Permalink to this definition">¶</a></dt>
4366 <dd><p>Get the attibutes of the self.xmlroot</p>
4367 <table class="docutils field-list" frame="void" rules="none">
4368 <col class="field-name" />
4369 <col class="field-body" />
4370 <tbody valign="top">
4371 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The attributes of the root node</td>
4372 </tr>
4373 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
4374 </tr>
4375 </tbody>
4376 </table>
4377 </dd></dl>
4378
4379 <dl class="method">
4380 <dt id="src.xmlManager.ReadXmlFile.get_attrib">
4381 <code class="descname">get_attrib</code><span class="sig-paren">(</span><em>node_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#ReadXmlFile.get_attrib"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.ReadXmlFile.get_attrib" title="Permalink to this definition">¶</a></dt>
4382 <dd><p>Get the attibutes of the node node_name in self.xmlroot</p>
4383 <table class="docutils field-list" frame="void" rules="none">
4384 <col class="field-name" />
4385 <col class="field-body" />
4386 <tbody valign="top">
4387 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>node_name</em>) – the name of the node</td>
4388 </tr>
4389 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the attibutes of the node node_name in self.xmlroot</td>
4390 </tr>
4391 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
4392 </tr>
4393 </tbody>
4394 </table>
4395 </dd></dl>
4396
4397 <dl class="method">
4398 <dt id="src.xmlManager.ReadXmlFile.get_node_text">
4399 <code class="descname">get_node_text</code><span class="sig-paren">(</span><em>node</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#ReadXmlFile.get_node_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.ReadXmlFile.get_node_text" title="Permalink to this definition">¶</a></dt>
4400 <dd><dl class="docutils">
4401 <dt>Get the text of the first node that has name </dt>
4402 <dd>that corresponds to the parameter node</dd>
4403 </dl>
4404 <table class="docutils field-list" frame="void" rules="none">
4405 <col class="field-name" />
4406 <col class="field-body" />
4407 <tbody valign="top">
4408 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>node</em>) – the name of the node from which get the text</td>
4409 </tr>
4410 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the text of the first node that has name
4411 that corresponds to the parameter node</td>
4412 </tr>
4413 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
4414 </tr>
4415 </tbody>
4416 </table>
4417 </dd></dl>
4418
4419 </dd></dl>
4420
4421 <dl class="class">
4422 <dt id="src.xmlManager.XmlLogFile">
4423 <em class="property">class </em><code class="descclassname">src.xmlManager.</code><code class="descname">XmlLogFile</code><span class="sig-paren">(</span><em>filePath</em>, <em>rootname</em>, <em>attrib={}</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#XmlLogFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.XmlLogFile" title="Permalink to this definition">¶</a></dt>
4424 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
4425 <p>Class to manage writing in salomeTools xml log file</p>
4426 <dl class="method">
4427 <dt id="src.xmlManager.XmlLogFile.add_simple_node">
4428 <code class="descname">add_simple_node</code><span class="sig-paren">(</span><em>node_name</em>, <em>text=None</em>, <em>attrib={}</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#XmlLogFile.add_simple_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.XmlLogFile.add_simple_node" title="Permalink to this definition">¶</a></dt>
4429 <dd><p>Add a node with some attibutes and text to the root node.</p>
4430 <table class="docutils field-list" frame="void" rules="none">
4431 <col class="field-name" />
4432 <col class="field-body" />
4433 <tbody valign="top">
4434 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
4435 <li><strong>str</strong> (<em>text</em>) – the name of the node to add</li>
4436 <li><strong>str</strong> – the text of the node</li>
4437 <li><strong>dict</strong> (<em>attrib</em>) – the dictionary containing the
4438 attribute of the new node</li>
4439 </ul>
4440 </td>
4441 </tr>
4442 </tbody>
4443 </table>
4444 </dd></dl>
4445
4446 <dl class="method">
4447 <dt id="src.xmlManager.XmlLogFile.append_node_attrib">
4448 <code class="descname">append_node_attrib</code><span class="sig-paren">(</span><em>node_name</em>, <em>attrib</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#XmlLogFile.append_node_attrib"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.XmlLogFile.append_node_attrib" title="Permalink to this definition">¶</a></dt>
4449 <dd><p>Append a new attributes to the node that has node_name as name</p>
4450 <table class="docutils field-list" frame="void" rules="none">
4451 <col class="field-name" />
4452 <col class="field-body" />
4453 <tbody valign="top">
4454 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
4455 <li><strong>str</strong> (<em>node_name</em>) – The name of the node on which append text</li>
4456 <li><strong>dixt</strong> (<em>attrib</em>) – The attrib to append</li>
4457 </ul>
4458 </td>
4459 </tr>
4460 </tbody>
4461 </table>
4462 </dd></dl>
4463
4464 <dl class="method">
4465 <dt id="src.xmlManager.XmlLogFile.append_node_text">
4466 <code class="descname">append_node_text</code><span class="sig-paren">(</span><em>node_name</em>, <em>text</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#XmlLogFile.append_node_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.XmlLogFile.append_node_text" title="Permalink to this definition">¶</a></dt>
4467 <dd><p>Append a new text to the node that has node_name as name</p>
4468 <table class="docutils field-list" frame="void" rules="none">
4469 <col class="field-name" />
4470 <col class="field-body" />
4471 <tbody valign="top">
4472 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
4473 <li><strong>str</strong> (<em>text</em>) – The name of the node on which append text</li>
4474 <li><strong>str</strong> – The text to append</li>
4475 </ul>
4476 </td>
4477 </tr>
4478 </tbody>
4479 </table>
4480 </dd></dl>
4481
4482 <dl class="method">
4483 <dt id="src.xmlManager.XmlLogFile.write_tree">
4484 <code class="descname">write_tree</code><span class="sig-paren">(</span><em>stylesheet=None</em>, <em>file_path=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#XmlLogFile.write_tree"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.XmlLogFile.write_tree" title="Permalink to this definition">¶</a></dt>
4485 <dd><p>Write the xml tree in the log file path. Add the stylesheet if asked.</p>
4486 <table class="docutils field-list" frame="void" rules="none">
4487 <col class="field-name" />
4488 <col class="field-body" />
4489 <tbody valign="top">
4490 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>stylesheet</em>) – The stylesheet to apply to the xml file</td>
4491 </tr>
4492 </tbody>
4493 </table>
4494 </dd></dl>
4495
4496 </dd></dl>
4497
4498 <dl class="function">
4499 <dt id="src.xmlManager.add_simple_node">
4500 <code class="descclassname">src.xmlManager.</code><code class="descname">add_simple_node</code><span class="sig-paren">(</span><em>root_node</em>, <em>node_name</em>, <em>text=None</em>, <em>attrib={}</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#add_simple_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.add_simple_node" title="Permalink to this definition">¶</a></dt>
4501 <dd><p>Add a node with some attibutes and text to the root node.</p>
4502 <table class="docutils field-list" frame="void" rules="none">
4503 <col class="field-name" />
4504 <col class="field-body" />
4505 <tbody valign="top">
4506 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
4507 <li><strong>etree.Element</strong> (<em>root_node</em>) – the Etree element where to add the new node</li>
4508 <li><strong>str</strong> (<em>text</em>) – the name of the node to add</li>
4509 <li><strong>str</strong> – the text of the node</li>
4510 <li><strong>dict</strong> (<em>attrib</em>) – the dictionary containing the
4511 attribute of the new node</li>
4512 </ul>
4513 </td>
4514 </tr>
4515 </tbody>
4516 </table>
4517 </dd></dl>
4518
4519 <dl class="function">
4520 <dt id="src.xmlManager.append_node_attrib">
4521 <code class="descclassname">src.xmlManager.</code><code class="descname">append_node_attrib</code><span class="sig-paren">(</span><em>root_node</em>, <em>attrib</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#append_node_attrib"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.append_node_attrib" title="Permalink to this definition">¶</a></dt>
4522 <dd><p>Append a new attributes to the node that has node_name as name</p>
4523 <table class="docutils field-list" frame="void" rules="none">
4524 <col class="field-name" />
4525 <col class="field-body" />
4526 <tbody valign="top">
4527 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
4528 <li><strong>etree.Element</strong> (<em>root_node</em>) – the Etree element
4529 where to append the new attibutes</li>
4530 <li><strong>dixt</strong> (<em>attrib</em>) – The attrib to append</li>
4531 </ul>
4532 </td>
4533 </tr>
4534 </tbody>
4535 </table>
4536 </dd></dl>
4537
4538 <dl class="function">
4539 <dt id="src.xmlManager.find_node_by_attrib">
4540 <code class="descclassname">src.xmlManager.</code><code class="descname">find_node_by_attrib</code><span class="sig-paren">(</span><em>xmlroot</em>, <em>name_node</em>, <em>key</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#find_node_by_attrib"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.find_node_by_attrib" title="Permalink to this definition">¶</a></dt>
4541 <dd><dl class="docutils">
4542 <dt>Find the nfirst ode from xmlroot that has name name_node and that has in </dt>
4543 <dd>its attributes {key : value}. Return the node</dd>
4544 </dl>
4545 <table class="docutils field-list" frame="void" rules="none">
4546 <col class="field-name" />
4547 <col class="field-body" />
4548 <tbody valign="top">
4549 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
4550 <li><strong>etree.Element</strong> (<em>xmlroot</em>) – the Etree element where to search</li>
4551 <li><strong>str</strong> (<em>value</em>) – the name of node to search</li>
4552 <li><strong>str</strong> – the key to search</li>
4553 <li><strong>str</strong> – the value to search</li>
4554 </ul>
4555 </td>
4556 </tr>
4557 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the found node</p>
4558 </td>
4559 </tr>
4560 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">xmlroot etree.Element</p>
4561 </td>
4562 </tr>
4563 </tbody>
4564 </table>
4565 </dd></dl>
4566
4567 <dl class="function">
4568 <dt id="src.xmlManager.write_report">
4569 <code class="descclassname">src.xmlManager.</code><code class="descname">write_report</code><span class="sig-paren">(</span><em>filename</em>, <em>xmlroot</em>, <em>stylesheet</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src/xmlManager.html#write_report"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.xmlManager.write_report" title="Permalink to this definition">¶</a></dt>
4570 <dd><p>Writes a report file from a XML tree.</p>
4571 <table class="docutils field-list" frame="void" rules="none">
4572 <col class="field-name" />
4573 <col class="field-body" />
4574 <tbody valign="top">
4575 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
4576 <li><strong>str</strong> (<em>stylesheet</em>) – The path to the file to create</li>
4577 <li><strong>etree.Element</strong> (<em>xmlroot</em>) – the Etree element to write to the file</li>
4578 <li><strong>str</strong> – The stylesheet to add to the begin of the file</li>
4579 </ul>
4580 </td>
4581 </tr>
4582 </tbody>
4583 </table>
4584 </dd></dl>
4585
4586 </div>
4587 <div class="section" id="module-src">
4588 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-src" title="Permalink to this headline">¶</a></h2>
4589 <p>initial imports and utilities methods for salomeTools</p>
4590 <dl class="class">
4591 <dt id="src.Path">
4592 <em class="property">class </em><code class="descclassname">src.</code><code class="descname">Path</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path" title="Permalink to this definition">¶</a></dt>
4593 <dd><dl class="method">
4594 <dt id="src.Path.base">
4595 <code class="descname">base</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.base"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.base" title="Permalink to this definition">¶</a></dt>
4596 <dd></dd></dl>
4597
4598 <dl class="method">
4599 <dt id="src.Path.chmod">
4600 <code class="descname">chmod</code><span class="sig-paren">(</span><em>mode</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.chmod"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.chmod" title="Permalink to this definition">¶</a></dt>
4601 <dd></dd></dl>
4602
4603 <dl class="method">
4604 <dt id="src.Path.copy">
4605 <code class="descname">copy</code><span class="sig-paren">(</span><em>path</em>, <em>smart=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.copy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.copy" title="Permalink to this definition">¶</a></dt>
4606 <dd></dd></dl>
4607
4608 <dl class="method">
4609 <dt id="src.Path.copydir">
4610 <code class="descname">copydir</code><span class="sig-paren">(</span><em>dst</em>, <em>smart=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.copydir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.copydir" title="Permalink to this definition">¶</a></dt>
4611 <dd></dd></dl>
4612
4613 <dl class="method">
4614 <dt id="src.Path.copyfile">
4615 <code class="descname">copyfile</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.copyfile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.copyfile" title="Permalink to this definition">¶</a></dt>
4616 <dd></dd></dl>
4617
4618 <dl class="method">
4619 <dt id="src.Path.copylink">
4620 <code class="descname">copylink</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.copylink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.copylink" title="Permalink to this definition">¶</a></dt>
4621 <dd></dd></dl>
4622
4623 <dl class="method">
4624 <dt id="src.Path.dir">
4625 <code class="descname">dir</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.dir" title="Permalink to this definition">¶</a></dt>
4626 <dd></dd></dl>
4627
4628 <dl class="method">
4629 <dt id="src.Path.exists">
4630 <code class="descname">exists</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.exists" title="Permalink to this definition">¶</a></dt>
4631 <dd></dd></dl>
4632
4633 <dl class="method">
4634 <dt id="src.Path.isdir">
4635 <code class="descname">isdir</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.isdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.isdir" title="Permalink to this definition">¶</a></dt>
4636 <dd></dd></dl>
4637
4638 <dl class="method">
4639 <dt id="src.Path.isfile">
4640 <code class="descname">isfile</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.isfile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.isfile" title="Permalink to this definition">¶</a></dt>
4641 <dd></dd></dl>
4642
4643 <dl class="method">
4644 <dt id="src.Path.islink">
4645 <code class="descname">islink</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.islink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.islink" title="Permalink to this definition">¶</a></dt>
4646 <dd></dd></dl>
4647
4648 <dl class="method">
4649 <dt id="src.Path.list">
4650 <code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.list" title="Permalink to this definition">¶</a></dt>
4651 <dd></dd></dl>
4652
4653 <dl class="method">
4654 <dt id="src.Path.make">
4655 <code class="descname">make</code><span class="sig-paren">(</span><em>mode=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.make"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.make" title="Permalink to this definition">¶</a></dt>
4656 <dd></dd></dl>
4657
4658 <dl class="method">
4659 <dt id="src.Path.readlink">
4660 <code class="descname">readlink</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.readlink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.readlink" title="Permalink to this definition">¶</a></dt>
4661 <dd></dd></dl>
4662
4663 <dl class="method">
4664 <dt id="src.Path.rm">
4665 <code class="descname">rm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.rm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.rm" title="Permalink to this definition">¶</a></dt>
4666 <dd></dd></dl>
4667
4668 <dl class="method">
4669 <dt id="src.Path.smartcopy">
4670 <code class="descname">smartcopy</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.smartcopy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.smartcopy" title="Permalink to this definition">¶</a></dt>
4671 <dd></dd></dl>
4672
4673 <dl class="method">
4674 <dt id="src.Path.symlink">
4675 <code class="descname">symlink</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#Path.symlink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.Path.symlink" title="Permalink to this definition">¶</a></dt>
4676 <dd></dd></dl>
4677
4678 </dd></dl>
4679
4680 <dl class="exception">
4681 <dt id="src.SatException">
4682 <em class="property">exception </em><code class="descclassname">src.</code><code class="descname">SatException</code><a class="reference internal" href="../../_modules/src.html#SatException"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.SatException" title="Permalink to this definition">¶</a></dt>
4683 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">exceptions.Exception</span></code></p>
4684 <p>rename Exception Class</p>
4685 </dd></dl>
4686
4687 <dl class="function">
4688 <dt id="src.activate_mesa_property">
4689 <code class="descclassname">src.</code><code class="descname">activate_mesa_property</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#activate_mesa_property"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.activate_mesa_property" title="Permalink to this definition">¶</a></dt>
4690 <dd><p>Add mesa property into application properties</p>
4691 <table class="docutils field-list" frame="void" rules="none">
4692 <col class="field-name" />
4693 <col class="field-body" />
4694 <tbody valign="top">
4695 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>config</em>) – The global configuration. It must have an application!</td>
4696 </tr>
4697 </tbody>
4698 </table>
4699 </dd></dl>
4700
4701 <dl class="function">
4702 <dt id="src.check_config_has_application">
4703 <code class="descclassname">src.</code><code class="descname">check_config_has_application</code><span class="sig-paren">(</span><em>config</em>, <em>details=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#check_config_has_application"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.check_config_has_application" title="Permalink to this definition">¶</a></dt>
4704 <dd><p>check that the config has the key APPLICATION. Else raise an exception.</p>
4705 <table class="docutils field-list" frame="void" rules="none">
4706 <col class="field-name" />
4707 <col class="field-body" />
4708 <tbody valign="top">
4709 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>class 'common.pyconf.Config'</strong> (<em>config</em>) – The config.</td>
4710 </tr>
4711 </tbody>
4712 </table>
4713 </dd></dl>
4714
4715 <dl class="function">
4716 <dt id="src.check_config_has_profile">
4717 <code class="descclassname">src.</code><code class="descname">check_config_has_profile</code><span class="sig-paren">(</span><em>config</em>, <em>details=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#check_config_has_profile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.check_config_has_profile" title="Permalink to this definition">¶</a></dt>
4718 <dd><p>check that the config has the key APPLICATION.profile.
4719 else, raise an exception.</p>
4720 <table class="docutils field-list" frame="void" rules="none">
4721 <col class="field-name" />
4722 <col class="field-body" />
4723 <tbody valign="top">
4724 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>class 'common.pyconf.Config'</strong> (<em>config</em>) – The config.</td>
4725 </tr>
4726 </tbody>
4727 </table>
4728 </dd></dl>
4729
4730 <dl class="function">
4731 <dt id="src.config_has_application">
4732 <code class="descclassname">src.</code><code class="descname">config_has_application</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#config_has_application"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.config_has_application" title="Permalink to this definition">¶</a></dt>
4733 <dd></dd></dl>
4734
4735 <dl class="function">
4736 <dt id="src.deepcopy_list">
4737 <code class="descclassname">src.</code><code class="descname">deepcopy_list</code><span class="sig-paren">(</span><em>input_list</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#deepcopy_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.deepcopy_list" title="Permalink to this definition">¶</a></dt>
4738 <dd><p>Do a deep copy of a list</p>
4739 <table class="docutils field-list" frame="void" rules="none">
4740 <col class="field-name" />
4741 <col class="field-body" />
4742 <tbody valign="top">
4743 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>List</strong> (<em>input_list</em>) – The list to copy</td>
4744 </tr>
4745 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The copy of the list</td>
4746 </tr>
4747 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">List</td>
4748 </tr>
4749 </tbody>
4750 </table>
4751 </dd></dl>
4752
4753 <dl class="function">
4754 <dt id="src.ensure_path_exists">
4755 <code class="descclassname">src.</code><code class="descname">ensure_path_exists</code><span class="sig-paren">(</span><em>p</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#ensure_path_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.ensure_path_exists" title="Permalink to this definition">¶</a></dt>
4756 <dd><p>Create a path if not existing</p>
4757 <table class="docutils field-list" frame="void" rules="none">
4758 <col class="field-name" />
4759 <col class="field-body" />
4760 <tbody valign="top">
4761 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>p</em>) – The path.</td>
4762 </tr>
4763 </tbody>
4764 </table>
4765 </dd></dl>
4766
4767 <dl class="function">
4768 <dt id="src.find_file_in_lpath">
4769 <code class="descclassname">src.</code><code class="descname">find_file_in_lpath</code><span class="sig-paren">(</span><em>file_name</em>, <em>lpath</em>, <em>additional_dir=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#find_file_in_lpath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.find_file_in_lpath" title="Permalink to this definition">¶</a></dt>
4770 <dd><p>Find in all the directories in lpath list the file that has the same name
4771 as file_name.
4772 If it is found
4773 then return the full path of the file
4774 else return False.</p>
4775 <p>The additional_dir (optional) is the name of the directory to add to all
4776 paths in lpath.</p>
4777 <table class="docutils field-list" frame="void" rules="none">
4778 <col class="field-name" />
4779 <col class="field-body" />
4780 <tbody valign="top">
4781 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
4782 <li><strong>str</strong> (<em>additional_dir</em>) – The file name to search</li>
4783 <li><strong>List</strong> (<em>lpath</em>) – The list of directories where to search</li>
4784 <li><strong>str</strong> – The name of the additional directory</li>
4785 </ul>
4786 </td>
4787 </tr>
4788 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the full path of the file or False if not found</p>
4789 </td>
4790 </tr>
4791 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
4792 </td>
4793 </tr>
4794 </tbody>
4795 </table>
4796 </dd></dl>
4797
4798 <dl class="function">
4799 <dt id="src.get_base_path">
4800 <code class="descclassname">src.</code><code class="descname">get_base_path</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#get_base_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.get_base_path" title="Permalink to this definition">¶</a></dt>
4801 <dd><p>Returns the path of the products base.</p>
4802 <table class="docutils field-list" frame="void" rules="none">
4803 <col class="field-name" />
4804 <col class="field-body" />
4805 <tbody valign="top">
4806 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>config</em>) – The global Config instance.</td>
4807 </tr>
4808 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The path of the products base.</td>
4809 </tr>
4810 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
4811 </tr>
4812 </tbody>
4813 </table>
4814 </dd></dl>
4815
4816 <dl class="function">
4817 <dt id="src.get_cfg_param">
4818 <code class="descclassname">src.</code><code class="descname">get_cfg_param</code><span class="sig-paren">(</span><em>config</em>, <em>param_name</em>, <em>default</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#get_cfg_param"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.get_cfg_param" title="Permalink to this definition">¶</a></dt>
4819 <dd><p>eearch for param_name value in config.
4820 if param_name is not in config
4821 then return default,
4822 else return the found value</p>
4823 <table class="docutils field-list" frame="void" rules="none">
4824 <col class="field-name" />
4825 <col class="field-body" />
4826 <tbody valign="top">
4827 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
4828 <li><strong>class 'common.pyconf.Config'</strong> (<em>config</em>) – The config.</li>
4829 <li><strong>str</strong> (<em>default</em>) – the name of the parameter to get the value</li>
4830 <li><strong>str</strong> – The value to return if param_name is not in config</li>
4831 </ul>
4832 </td>
4833 </tr>
4834 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">see initial description of the function</p>
4835 </td>
4836 </tr>
4837 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
4838 </td>
4839 </tr>
4840 </tbody>
4841 </table>
4842 </dd></dl>
4843
4844 <dl class="function">
4845 <dt id="src.get_launcher_name">
4846 <code class="descclassname">src.</code><code class="descname">get_launcher_name</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#get_launcher_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.get_launcher_name" title="Permalink to this definition">¶</a></dt>
4847 <dd><p>Returns the name of salome launcher.</p>
4848 <table class="docutils field-list" frame="void" rules="none">
4849 <col class="field-name" />
4850 <col class="field-body" />
4851 <tbody valign="top">
4852 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>config</em>) – The global Config instance.</td>
4853 </tr>
4854 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The name of salome launcher.</td>
4855 </tr>
4856 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
4857 </tr>
4858 </tbody>
4859 </table>
4860 </dd></dl>
4861
4862 <dl class="function">
4863 <dt id="src.get_log_path">
4864 <code class="descclassname">src.</code><code class="descname">get_log_path</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#get_log_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.get_log_path" title="Permalink to this definition">¶</a></dt>
4865 <dd><p>Returns the path of the logs.</p>
4866 <table class="docutils field-list" frame="void" rules="none">
4867 <col class="field-name" />
4868 <col class="field-body" />
4869 <tbody valign="top">
4870 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>Config</strong> (<em>config</em>) – The global Config instance.</td>
4871 </tr>
4872 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The path of the logs.</td>
4873 </tr>
4874 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
4875 </tr>
4876 </tbody>
4877 </table>
4878 </dd></dl>
4879
4880 <dl class="function">
4881 <dt id="src.get_property_in_product_cfg">
4882 <code class="descclassname">src.</code><code class="descname">get_property_in_product_cfg</code><span class="sig-paren">(</span><em>product_cfg</em>, <em>pprty</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#get_property_in_product_cfg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.get_property_in_product_cfg" title="Permalink to this definition">¶</a></dt>
4883 <dd></dd></dl>
4884
4885 <dl class="function">
4886 <dt id="src.get_salome_version">
4887 <code class="descclassname">src.</code><code class="descname">get_salome_version</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#get_salome_version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.get_salome_version" title="Permalink to this definition">¶</a></dt>
4888 <dd></dd></dl>
4889
4890 <dl class="function">
4891 <dt id="src.get_tmp_filename">
4892 <code class="descclassname">src.</code><code class="descname">get_tmp_filename</code><span class="sig-paren">(</span><em>cfg</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#get_tmp_filename"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.get_tmp_filename" title="Permalink to this definition">¶</a></dt>
4893 <dd></dd></dl>
4894
4895 <dl class="function">
4896 <dt id="src.handleRemoveReadonly">
4897 <code class="descclassname">src.</code><code class="descname">handleRemoveReadonly</code><span class="sig-paren">(</span><em>func</em>, <em>path</em>, <em>exc</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#handleRemoveReadonly"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.handleRemoveReadonly" title="Permalink to this definition">¶</a></dt>
4898 <dd></dd></dl>
4899
4900 <dl class="function">
4901 <dt id="src.merge_dicts">
4902 <code class="descclassname">src.</code><code class="descname">merge_dicts</code><span class="sig-paren">(</span><em>*dict_args</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#merge_dicts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.merge_dicts" title="Permalink to this definition">¶</a></dt>
4903 <dd><p>Given any number of dicts, shallow copy and merge into a new dict,
4904 precedence goes to key value pairs in latter dicts.</p>
4905 </dd></dl>
4906
4907 <dl class="function">
4908 <dt id="src.only_numbers">
4909 <code class="descclassname">src.</code><code class="descname">only_numbers</code><span class="sig-paren">(</span><em>str_num</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#only_numbers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.only_numbers" title="Permalink to this definition">¶</a></dt>
4910 <dd></dd></dl>
4911
4912 <dl class="function">
4913 <dt id="src.parse_date">
4914 <code class="descclassname">src.</code><code class="descname">parse_date</code><span class="sig-paren">(</span><em>date</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#parse_date"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.parse_date" title="Permalink to this definition">¶</a></dt>
4915 <dd><p>Transform YYYYMMDD_hhmmss into YYYY-MM-DD hh:mm:ss.</p>
4916 <table class="docutils field-list" frame="void" rules="none">
4917 <col class="field-name" />
4918 <col class="field-body" />
4919 <tbody valign="top">
4920 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>date</em>) – The date to transform</td>
4921 </tr>
4922 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The date in the new format</td>
4923 </tr>
4924 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
4925 </tr>
4926 </tbody>
4927 </table>
4928 </dd></dl>
4929
4930 <dl class="function">
4931 <dt id="src.print_info">
4932 <code class="descclassname">src.</code><code class="descname">print_info</code><span class="sig-paren">(</span><em>logger</em>, <em>info</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#print_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.print_info" title="Permalink to this definition">¶</a></dt>
4933 <dd><p>Prints the tuples that are in info variable in a formatted way.</p>
4934 <table class="docutils field-list" frame="void" rules="none">
4935 <col class="field-name" />
4936 <col class="field-body" />
4937 <tbody valign="top">
4938 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
4939 <li><strong>Logger</strong> (<em>logger</em>) – The logging instance to use for the prints.</li>
4940 <li><strong>list</strong> (<em>info</em>) – The list of tuples to display</li>
4941 </ul>
4942 </td>
4943 </tr>
4944 </tbody>
4945 </table>
4946 </dd></dl>
4947
4948 <dl class="function">
4949 <dt id="src.read_config_from_a_file">
4950 <code class="descclassname">src.</code><code class="descname">read_config_from_a_file</code><span class="sig-paren">(</span><em>filePath</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#read_config_from_a_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.read_config_from_a_file" title="Permalink to this definition">¶</a></dt>
4951 <dd></dd></dl>
4952
4953 <dl class="function">
4954 <dt id="src.remove_item_from_list">
4955 <code class="descclassname">src.</code><code class="descname">remove_item_from_list</code><span class="sig-paren">(</span><em>input_list</em>, <em>item</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#remove_item_from_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.remove_item_from_list" title="Permalink to this definition">¶</a></dt>
4956 <dd><p>Remove all occurences of item from input_list</p>
4957 <table class="docutils field-list" frame="void" rules="none">
4958 <col class="field-name" />
4959 <col class="field-body" />
4960 <tbody valign="top">
4961 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>List</strong> (<em>input_list</em>) – The list to modify</td>
4962 </tr>
4963 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The without any item</td>
4964 </tr>
4965 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">List</td>
4966 </tr>
4967 </tbody>
4968 </table>
4969 </dd></dl>
4970
4971 <dl class="function">
4972 <dt id="src.replace_in_file">
4973 <code class="descclassname">src.</code><code class="descname">replace_in_file</code><span class="sig-paren">(</span><em>filein</em>, <em>strin</em>, <em>strout</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/src.html#replace_in_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.replace_in_file" title="Permalink to this definition">¶</a></dt>
4974 <dd><p>Replace &lt;strin&gt; by &lt;strout&gt; in file &lt;filein&gt;</p>
4975 </dd></dl>
4976
4977 </div>
4978 </div>
4979
4980
4981           </div>
4982         </div>
4983       </div>
4984       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
4985         <div class="sphinxsidebarwrapper">
4986             <p class="logo"><a href="../../index.html">
4987               <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
4988             </a></p>
4989   <h3><a href="../../index.html">Table Of Contents</a></h3>
4990   <ul>
4991 <li><a class="reference internal" href="#">src package</a><ul>
4992 <li><a class="reference internal" href="#subpackages">Subpackages</a></li>
4993 <li><a class="reference internal" href="#submodules">Submodules</a></li>
4994 <li><a class="reference internal" href="#module-src.ElementTree">src.ElementTree module</a></li>
4995 <li><a class="reference internal" href="#module-src.architecture">src.architecture module</a></li>
4996 <li><a class="reference internal" href="#module-src.compilation">src.compilation module</a></li>
4997 <li><a class="reference internal" href="#module-src.debug">src.debug module</a></li>
4998 <li><a class="reference internal" href="#module-src.environment">src.environment module</a></li>
4999 <li><a class="reference internal" href="#module-src.fileEnviron">src.fileEnviron module</a></li>
5000 <li><a class="reference internal" href="#module-src.fork">src.fork module</a></li>
5001 <li><a class="reference internal" href="#module-src.logger">src.logger module</a></li>
5002 <li><a class="reference internal" href="#module-src.options">src.options module</a></li>
5003 <li><a class="reference internal" href="#module-src.printcolors">src.printcolors module</a></li>
5004 <li><a class="reference internal" href="#module-src.product">src.product module</a></li>
5005 <li><a class="reference internal" href="#module-src.pyconf">src.pyconf module</a></li>
5006 <li><a class="reference internal" href="#module-src.system">src.system module</a></li>
5007 <li><a class="reference internal" href="#module-src.template">src.template module</a></li>
5008 <li><a class="reference internal" href="#module-src.test_module">src.test_module module</a></li>
5009 <li><a class="reference internal" href="#module-src.xmlManager">src.xmlManager module</a></li>
5010 <li><a class="reference internal" href="#module-src">Module contents</a></li>
5011 </ul>
5012 </li>
5013 </ul>
5014 <div class="relations">
5015 <h3>Related Topics</h3>
5016 <ul>
5017   <li><a href="../../index.html">Documentation overview</a><ul>
5018   <li><a href="modules.html">src</a><ul>
5019       <li>Previous: <a href="modules.html" title="previous chapter">src</a></li>
5020       <li>Next: <a href="src.colorama.html" title="next chapter">src.colorama package</a></li>
5021   </ul></li>
5022   </ul></li>
5023 </ul>
5024 </div>
5025   <div role="note" aria-label="source link">
5026     <h3>This Page</h3>
5027     <ul class="this-page-menu">
5028       <li><a href="../../_sources/commands/apidoc/src.rst.txt"
5029             rel="nofollow">Show Source</a></li>
5030     </ul>
5031    </div>
5032 <div id="searchbox" style="display: none" role="search">
5033   <h3>Quick search</h3>
5034     <div class="searchformwrapper">
5035     <form class="search" action="../../search.html" method="get">
5036       <input type="text" name="q" />
5037       <input type="submit" value="Go" />
5038       <input type="hidden" name="check_keywords" value="yes" />
5039       <input type="hidden" name="area" value="default" />
5040     </form>
5041     </div>
5042 </div>
5043 <script type="text/javascript">$('#searchbox').show(0);</script>
5044         </div>
5045       </div>
5046       <div class="clearer"></div>
5047     </div>
5048     <div class="footer">
5049       &copy;2018, CEA.
5050
5051       |
5052       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.3</a>
5053       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
5054
5055       |
5056       <a href="../../_sources/commands/apidoc/src.rst.txt"
5057           rel="nofollow">Page source</a>
5058     </div>
5059
5060
5061
5062
5063   </body>
5064 </html>