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
   6 <html xmlns="http://www.w3.org/1999/xhtml">
   7   <head>
   8     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   9
  10     <title>src Package &mdash; salomeTools 5.0.0dev documentation</title>
  11
  12     <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
  13     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  14     <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
  15
  16     <script type="text/javascript">
  17       var DOCUMENTATION_OPTIONS = {
  18         URL_ROOT:    '../../',
  19         VERSION:     '5.0.0dev',
  20         COLLAPSE_INDEX: false,
  21         FILE_SUFFIX: '.html',
  22         HAS_SOURCE:  true
  23       };
  24     </script>
  25     <script type="text/javascript" src="../../_static/jquery.js"></script>
  26     <script type="text/javascript" src="../../_static/underscore.js"></script>
  27     <script type="text/javascript" src="../../_static/doctools.js"></script>
  28     <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
  29     <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
  30     <link rel="up" title="src" href="modules.html" />
  31     <link rel="next" title="colorama Package" href="src.colorama.html" />
  32     <link rel="prev" title="src" href="modules.html" />
  33
  34   <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  35
  36
  37   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  38
  39   </head>
  40   <body>
  41
  42
  43     <div class="document">
  44       <div class="documentwrapper">
  45         <div class="bodywrapper">
  46           <div class="body" role="main">
  47
  48   <div class="section" id="src-package">
  49 <h1>src Package<a class="headerlink" href="#src-package" title="Permalink to this headline">¶</a></h1>
  50 <div class="section" id="id1">
  51 <h2><tt class="xref py py-mod docutils literal"><span class="pre">src</span></tt> Package<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
  52 <span class="target" id="module-src.__init__"></span><p>initial imports and utilities methods for salomeTools</p>
  53 <dl class="class">
  54 <dt id="src.__init__.Path">
  55 <em class="property">class </em><tt class="descclassname">src.__init__.</tt><tt class="descname">Path</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#Path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.Path" title="Permalink to this definition">¶</a></dt>
  56 <dd><dl class="method">
  57 <dt id="src.__init__.Path.base">
  58 <tt class="descname">base</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#Path.base"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.Path.base" title="Permalink to this definition">¶</a></dt>
  59 <dd></dd></dl>
  60
  61 <dl class="method">
  62 <dt id="src.__init__.Path.chmod">
  63 <tt class="descname">chmod</tt><big>(</big><em>mode</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#Path.chmod"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.Path.chmod" title="Permalink to this definition">¶</a></dt>
  64 <dd></dd></dl>
  65
  66 <dl class="method">
  67 <dt id="src.__init__.Path.copy">
  68 <tt class="descname">copy</tt><big>(</big><em>path</em>, <em>smart=False</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#Path.copy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.Path.copy" title="Permalink to this definition">¶</a></dt>
  69 <dd></dd></dl>
  70
  71 <dl class="method">
  72 <dt id="src.__init__.Path.copydir">
  73 <tt class="descname">copydir</tt><big>(</big><em>dst</em>, <em>smart=False</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#Path.copydir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.Path.copydir" title="Permalink to this definition">¶</a></dt>
  74 <dd></dd></dl>
  75
  76 <dl class="method">
  77 <dt id="src.__init__.Path.copyfile">
  78 <tt class="descname">copyfile</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#Path.copyfile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.Path.copyfile" title="Permalink to this definition">¶</a></dt>
  79 <dd></dd></dl>
  80
  81 <dl class="method">
  82 <dt id="src.__init__.Path.copylink">
  83 <tt class="descname">copylink</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#Path.copylink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.Path.copylink" title="Permalink to this definition">¶</a></dt>
  84 <dd></dd></dl>
  85
  86 <dl class="method">
  87 <dt id="src.__init__.Path.dir">
  88 <tt class="descname">dir</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#Path.dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.Path.dir" title="Permalink to this definition">¶</a></dt>
  89 <dd></dd></dl>
  90
  91 <dl class="method">
  92 <dt id="src.__init__.Path.exists">
  93 <tt class="descname">exists</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#Path.exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.Path.exists" title="Permalink to this definition">¶</a></dt>
  94 <dd></dd></dl>
  95
  96 <dl class="method">
  97 <dt id="src.__init__.Path.isdir">
  98 <tt class="descname">isdir</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#Path.isdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.Path.isdir" title="Permalink to this definition">¶</a></dt>
  99 <dd></dd></dl>
 100
 101 <dl class="method">
 102 <dt id="src.__init__.Path.isfile">
 103 <tt class="descname">isfile</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#Path.isfile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.Path.isfile" title="Permalink to this definition">¶</a></dt>
 104 <dd></dd></dl>
 105
 106 <dl class="method">
 107 <dt id="src.__init__.Path.islink">
 108 <tt class="descname">islink</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#Path.islink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.Path.islink" title="Permalink to this definition">¶</a></dt>
 109 <dd></dd></dl>
 110
 111 <dl class="method">
 112 <dt id="src.__init__.Path.list">
 113 <tt class="descname">list</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#Path.list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.Path.list" title="Permalink to this definition">¶</a></dt>
 114 <dd></dd></dl>
 115
 116 <dl class="method">
 117 <dt id="src.__init__.Path.make">
 118 <tt class="descname">make</tt><big>(</big><em>mode=None</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#Path.make"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.Path.make" title="Permalink to this definition">¶</a></dt>
 119 <dd></dd></dl>
 120
 121 <dl class="method">
 122 <dt id="src.__init__.Path.readlink">
 123 <tt class="descname">readlink</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#Path.readlink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.Path.readlink" title="Permalink to this definition">¶</a></dt>
 124 <dd></dd></dl>
 125
 126 <dl class="method">
 127 <dt id="src.__init__.Path.rm">
 128 <tt class="descname">rm</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#Path.rm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.Path.rm" title="Permalink to this definition">¶</a></dt>
 129 <dd></dd></dl>
 130
 131 <dl class="method">
 132 <dt id="src.__init__.Path.smartcopy">
 133 <tt class="descname">smartcopy</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#Path.smartcopy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.Path.smartcopy" title="Permalink to this definition">¶</a></dt>
 134 <dd></dd></dl>
 135
 136 <dl class="method">
 137 <dt id="src.__init__.Path.symlink">
 138 <tt class="descname">symlink</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#Path.symlink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.Path.symlink" title="Permalink to this definition">¶</a></dt>
 139 <dd></dd></dl>
 140
 141 </dd></dl>
 142
 143 <dl class="exception">
 144 <dt id="src.__init__.SatException">
 145 <em class="property">exception </em><tt class="descclassname">src.__init__.</tt><tt class="descname">SatException</tt><a class="reference internal" href="../../_modules/src/__init__.html#SatException"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.SatException" title="Permalink to this definition">¶</a></dt>
 146 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p>
 147 <p>rename Exception Class</p>
 148 </dd></dl>
 149
 150 <dl class="function">
 151 <dt id="src.__init__.activate_mesa_property">
 152 <tt class="descclassname">src.__init__.</tt><tt class="descname">activate_mesa_property</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#activate_mesa_property"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.activate_mesa_property" title="Permalink to this definition">¶</a></dt>
 153 <dd><p>Add mesa property into application properties</p>
 154 <table class="docutils field-list" frame="void" rules="none">
 155 <col class="field-name" />
 156 <col class="field-body" />
 157 <tbody valign="top">
 158 <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>
 159 </tr>
 160 </tbody>
 161 </table>
 162 </dd></dl>
 163
 164 <dl class="function">
 165 <dt id="src.__init__.check_config_has_application">
 166 <tt class="descclassname">src.__init__.</tt><tt class="descname">check_config_has_application</tt><big>(</big><em>config</em>, <em>details=None</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#check_config_has_application"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.check_config_has_application" title="Permalink to this definition">¶</a></dt>
 167 <dd><p>check that the config has the key APPLICATION. Else raise an exception.</p>
 168 <table class="docutils field-list" frame="void" rules="none">
 169 <col class="field-name" />
 170 <col class="field-body" />
 171 <tbody valign="top">
 172 <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>
 173 </tr>
 174 </tbody>
 175 </table>
 176 </dd></dl>
 177
 178 <dl class="function">
 179 <dt id="src.__init__.check_config_has_profile">
 180 <tt class="descclassname">src.__init__.</tt><tt class="descname">check_config_has_profile</tt><big>(</big><em>config</em>, <em>details=None</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#check_config_has_profile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.check_config_has_profile" title="Permalink to this definition">¶</a></dt>
 181 <dd><p>check that the config has the key APPLICATION.profile.
 182 else, raise an exception.</p>
 183 <table class="docutils field-list" frame="void" rules="none">
 184 <col class="field-name" />
 185 <col class="field-body" />
 186 <tbody valign="top">
 187 <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>
 188 </tr>
 189 </tbody>
 190 </table>
 191 </dd></dl>
 192
 193 <dl class="function">
 194 <dt id="src.__init__.config_has_application">
 195 <tt class="descclassname">src.__init__.</tt><tt class="descname">config_has_application</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#config_has_application"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.config_has_application" title="Permalink to this definition">¶</a></dt>
 196 <dd></dd></dl>
 197
 198 <dl class="function">
 199 <dt id="src.__init__.deepcopy_list">
 200 <tt class="descclassname">src.__init__.</tt><tt class="descname">deepcopy_list</tt><big>(</big><em>input_list</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#deepcopy_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.deepcopy_list" title="Permalink to this definition">¶</a></dt>
 201 <dd><p>Do a deep copy of a list</p>
 202 <table class="docutils field-list" frame="void" rules="none">
 203 <col class="field-name" />
 204 <col class="field-body" />
 205 <tbody valign="top">
 206 <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>
 207 </tr>
 208 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The copy of the list</td>
 209 </tr>
 210 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">List</td>
 211 </tr>
 212 </tbody>
 213 </table>
 214 </dd></dl>
 215
 216 <dl class="function">
 217 <dt id="src.__init__.ensure_path_exists">
 218 <tt class="descclassname">src.__init__.</tt><tt class="descname">ensure_path_exists</tt><big>(</big><em>p</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#ensure_path_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.ensure_path_exists" title="Permalink to this definition">¶</a></dt>
 219 <dd><p>Create a path if not existing</p>
 220 <table class="docutils field-list" frame="void" rules="none">
 221 <col class="field-name" />
 222 <col class="field-body" />
 223 <tbody valign="top">
 224 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>p</em>) -- The path.</td>
 225 </tr>
 226 </tbody>
 227 </table>
 228 </dd></dl>
 229
 230 <dl class="function">
 231 <dt id="src.__init__.find_file_in_lpath">
 232 <tt class="descclassname">src.__init__.</tt><tt class="descname">find_file_in_lpath</tt><big>(</big><em>file_name</em>, <em>lpath</em>, <em>additional_dir=''</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#find_file_in_lpath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.find_file_in_lpath" title="Permalink to this definition">¶</a></dt>
 233 <dd><p>Find in all the directories in lpath list the file that has the same name
 234 as file_name.
 235 If it is found
 236 then return the full path of the file
 237 else return False.</p>
 238 <p>The additional_dir (optional) is the name of the directory to add to all
 239 paths in lpath.</p>
 240 <table class="docutils field-list" frame="void" rules="none">
 241 <col class="field-name" />
 242 <col class="field-body" />
 243 <tbody valign="top">
 244 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 245 <li><strong>str</strong> (<em>additional_dir</em>) -- The file name to search</li>
 246 <li><strong>List</strong> (<em>lpath</em>) -- The list of directories where to search</li>
 247 <li><strong>str</strong> -- The name of the additional directory</li>
 248 </ul>
 249 </td>
 250 </tr>
 251 <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>
 252 </td>
 253 </tr>
 254 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
 255 </td>
 256 </tr>
 257 </tbody>
 258 </table>
 259 </dd></dl>
 260
 261 <dl class="function">
 262 <dt id="src.__init__.get_base_path">
 263 <tt class="descclassname">src.__init__.</tt><tt class="descname">get_base_path</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#get_base_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.get_base_path" title="Permalink to this definition">¶</a></dt>
 264 <dd><p>Returns the path of the products base.</p>
 265 <table class="docutils field-list" frame="void" rules="none">
 266 <col class="field-name" />
 267 <col class="field-body" />
 268 <tbody valign="top">
 269 <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>
 270 </tr>
 271 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The path of the products base.</td>
 272 </tr>
 273 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
 274 </tr>
 275 </tbody>
 276 </table>
 277 </dd></dl>
 278
 279 <dl class="function">
 280 <dt id="src.__init__.get_cfg_param">
 281 <tt class="descclassname">src.__init__.</tt><tt class="descname">get_cfg_param</tt><big>(</big><em>config</em>, <em>param_name</em>, <em>default</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#get_cfg_param"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.get_cfg_param" title="Permalink to this definition">¶</a></dt>
 282 <dd><p>eearch for param_name value in config.
 283 if param_name is not in config
 284 then return default,
 285 else return the found value</p>
 286 <table class="docutils field-list" frame="void" rules="none">
 287 <col class="field-name" />
 288 <col class="field-body" />
 289 <tbody valign="top">
 290 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 291 <li><strong>class 'common.pyconf.Config'</strong> (<em>config</em>) -- The config.</li>
 292 <li><strong>str</strong> (<em>default</em>) -- the name of the parameter to get the value</li>
 293 <li><strong>str</strong> -- The value to return if param_name is not in config</li>
 294 </ul>
 295 </td>
 296 </tr>
 297 <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>
 298 </td>
 299 </tr>
 300 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
 301 </td>
 302 </tr>
 303 </tbody>
 304 </table>
 305 </dd></dl>
 306
 307 <dl class="function">
 308 <dt id="src.__init__.get_launcher_name">
 309 <tt class="descclassname">src.__init__.</tt><tt class="descname">get_launcher_name</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#get_launcher_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.get_launcher_name" title="Permalink to this definition">¶</a></dt>
 310 <dd><p>Returns the name of salome launcher.</p>
 311 <table class="docutils field-list" frame="void" rules="none">
 312 <col class="field-name" />
 313 <col class="field-body" />
 314 <tbody valign="top">
 315 <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>
 316 </tr>
 317 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The name of salome launcher.</td>
 318 </tr>
 319 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
 320 </tr>
 321 </tbody>
 322 </table>
 323 </dd></dl>
 324
 325 <dl class="function">
 326 <dt id="src.__init__.get_log_path">
 327 <tt class="descclassname">src.__init__.</tt><tt class="descname">get_log_path</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#get_log_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.get_log_path" title="Permalink to this definition">¶</a></dt>
 328 <dd><p>Returns the path of the logs.</p>
 329 <table class="docutils field-list" frame="void" rules="none">
 330 <col class="field-name" />
 331 <col class="field-body" />
 332 <tbody valign="top">
 333 <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>
 334 </tr>
 335 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The path of the logs.</td>
 336 </tr>
 337 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
 338 </tr>
 339 </tbody>
 340 </table>
 341 </dd></dl>
 342
 343 <dl class="function">
 344 <dt id="src.__init__.get_property_in_product_cfg">
 345 <tt class="descclassname">src.__init__.</tt><tt class="descname">get_property_in_product_cfg</tt><big>(</big><em>product_cfg</em>, <em>pprty</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#get_property_in_product_cfg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.get_property_in_product_cfg" title="Permalink to this definition">¶</a></dt>
 346 <dd></dd></dl>
 347
 348 <dl class="function">
 349 <dt id="src.__init__.get_salome_version">
 350 <tt class="descclassname">src.__init__.</tt><tt class="descname">get_salome_version</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#get_salome_version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.get_salome_version" title="Permalink to this definition">¶</a></dt>
 351 <dd></dd></dl>
 352
 353 <dl class="function">
 354 <dt id="src.__init__.get_tmp_filename">
 355 <tt class="descclassname">src.__init__.</tt><tt class="descname">get_tmp_filename</tt><big>(</big><em>cfg</em>, <em>name</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#get_tmp_filename"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.get_tmp_filename" title="Permalink to this definition">¶</a></dt>
 356 <dd></dd></dl>
 357
 358 <dl class="function">
 359 <dt id="src.__init__.handleRemoveReadonly">
 360 <tt class="descclassname">src.__init__.</tt><tt class="descname">handleRemoveReadonly</tt><big>(</big><em>func</em>, <em>path</em>, <em>exc</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#handleRemoveReadonly"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.handleRemoveReadonly" title="Permalink to this definition">¶</a></dt>
 361 <dd></dd></dl>
 362
 363 <dl class="function">
 364 <dt id="src.__init__.merge_dicts">
 365 <tt class="descclassname">src.__init__.</tt><tt class="descname">merge_dicts</tt><big>(</big><em>*dict_args</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#merge_dicts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.merge_dicts" title="Permalink to this definition">¶</a></dt>
 366 <dd><p>Given any number of dicts, shallow copy and merge into a new dict,
 367 precedence goes to key value pairs in latter dicts.</p>
 368 </dd></dl>
 369
 370 <dl class="function">
 371 <dt id="src.__init__.only_numbers">
 372 <tt class="descclassname">src.__init__.</tt><tt class="descname">only_numbers</tt><big>(</big><em>str_num</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#only_numbers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.only_numbers" title="Permalink to this definition">¶</a></dt>
 373 <dd></dd></dl>
 374
 375 <dl class="function">
 376 <dt id="src.__init__.parse_date">
 377 <tt class="descclassname">src.__init__.</tt><tt class="descname">parse_date</tt><big>(</big><em>date</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#parse_date"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.parse_date" title="Permalink to this definition">¶</a></dt>
 378 <dd><p>Transform YYYYMMDD_hhmmss into YYYY-MM-DD hh:mm:ss.</p>
 379 <table class="docutils field-list" frame="void" rules="none">
 380 <col class="field-name" />
 381 <col class="field-body" />
 382 <tbody valign="top">
 383 <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>
 384 </tr>
 385 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The date in the new format</td>
 386 </tr>
 387 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
 388 </tr>
 389 </tbody>
 390 </table>
 391 </dd></dl>
 392
 393 <dl class="function">
 394 <dt id="src.__init__.print_info">
 395 <tt class="descclassname">src.__init__.</tt><tt class="descname">print_info</tt><big>(</big><em>logger</em>, <em>info</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#print_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.print_info" title="Permalink to this definition">¶</a></dt>
 396 <dd><p>Prints the tuples that are in info variable in a formatted way.</p>
 397 <table class="docutils field-list" frame="void" rules="none">
 398 <col class="field-name" />
 399 <col class="field-body" />
 400 <tbody valign="top">
 401 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 402 <li><strong>Logger</strong> (<em>logger</em>) -- The logging instance to use for the prints.</li>
 403 <li><strong>list</strong> (<em>info</em>) -- The list of tuples to display</li>
 404 </ul>
 405 </td>
 406 </tr>
 407 </tbody>
 408 </table>
 409 </dd></dl>
 410
 411 <dl class="function">
 412 <dt id="src.__init__.read_config_from_a_file">
 413 <tt class="descclassname">src.__init__.</tt><tt class="descname">read_config_from_a_file</tt><big>(</big><em>filePath</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#read_config_from_a_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.read_config_from_a_file" title="Permalink to this definition">¶</a></dt>
 414 <dd></dd></dl>
 415
 416 <dl class="function">
 417 <dt id="src.__init__.remove_item_from_list">
 418 <tt class="descclassname">src.__init__.</tt><tt class="descname">remove_item_from_list</tt><big>(</big><em>input_list</em>, <em>item</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#remove_item_from_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.remove_item_from_list" title="Permalink to this definition">¶</a></dt>
 419 <dd><p>Remove all occurences of item from input_list</p>
 420 <table class="docutils field-list" frame="void" rules="none">
 421 <col class="field-name" />
 422 <col class="field-body" />
 423 <tbody valign="top">
 424 <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>
 425 </tr>
 426 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The without any item</td>
 427 </tr>
 428 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">List</td>
 429 </tr>
 430 </tbody>
 431 </table>
 432 </dd></dl>
 433
 434 <dl class="function">
 435 <dt id="src.__init__.replace_in_file">
 436 <tt class="descclassname">src.__init__.</tt><tt class="descname">replace_in_file</tt><big>(</big><em>filein</em>, <em>strin</em>, <em>strout</em><big>)</big><a class="reference internal" href="../../_modules/src/__init__.html#replace_in_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.__init__.replace_in_file" title="Permalink to this definition">¶</a></dt>
 437 <dd><p>Replace &lt;strin&gt; by &lt;strout&gt; in file &lt;filein&gt;</p>
 438 </dd></dl>
 439
 440 </div>
 441 <div class="section" id="module-src.ElementTree">
 442 <span id="elementtree-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">ElementTree</span></tt> Module<a class="headerlink" href="#module-src.ElementTree" title="Permalink to this headline">¶</a></h2>
 443 <dl class="function">
 444 <dt id="src.ElementTree.Comment">
 445 <tt class="descclassname">src.ElementTree.</tt><tt class="descname">Comment</tt><big>(</big><em>text=None</em><big>)</big><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>
 446 <dd></dd></dl>
 447
 448 <dl class="function">
 449 <dt id="src.ElementTree.dump">
 450 <tt class="descclassname">src.ElementTree.</tt><tt class="descname">dump</tt><big>(</big><em>elem</em><big>)</big><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>
 451 <dd></dd></dl>
 452
 453 <dl class="function">
 454 <dt id="src.ElementTree.Element">
 455 <tt class="descclassname">src.ElementTree.</tt><tt class="descname">Element</tt><big>(</big><em>tag</em>, <em>attrib={}</em>, <em>**extra</em><big>)</big><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>
 456 <dd></dd></dl>
 457
 458 <dl class="class">
 459 <dt id="src.ElementTree.ElementTree">
 460 <em class="property">class </em><tt class="descclassname">src.ElementTree.</tt><tt class="descname">ElementTree</tt><big>(</big><em>element=None</em>, <em>file=None</em><big>)</big><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>
 461 <dd><dl class="method">
 462 <dt id="src.ElementTree.ElementTree.find">
 463 <tt class="descname">find</tt><big>(</big><em>path</em><big>)</big><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>
 464 <dd></dd></dl>
 465
 466 <dl class="method">
 467 <dt id="src.ElementTree.ElementTree.findall">
 468 <tt class="descname">findall</tt><big>(</big><em>path</em><big>)</big><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>
 469 <dd></dd></dl>
 470
 471 <dl class="method">
 472 <dt id="src.ElementTree.ElementTree.findtext">
 473 <tt class="descname">findtext</tt><big>(</big><em>path</em>, <em>default=None</em><big>)</big><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>
 474 <dd></dd></dl>
 475
 476 <dl class="method">
 477 <dt id="src.ElementTree.ElementTree.getiterator">
 478 <tt class="descname">getiterator</tt><big>(</big><em>tag=None</em><big>)</big><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>
 479 <dd></dd></dl>
 480
 481 <dl class="method">
 482 <dt id="src.ElementTree.ElementTree.getroot">
 483 <tt class="descname">getroot</tt><big>(</big><big>)</big><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>
 484 <dd></dd></dl>
 485
 486 <dl class="method">
 487 <dt id="src.ElementTree.ElementTree.parse">
 488 <tt class="descname">parse</tt><big>(</big><em>source</em>, <em>parser=None</em><big>)</big><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>
 489 <dd></dd></dl>
 490
 491 <dl class="method">
 492 <dt id="src.ElementTree.ElementTree.write">
 493 <tt class="descname">write</tt><big>(</big><em>file</em>, <em>encoding='us-ascii'</em><big>)</big><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>
 494 <dd></dd></dl>
 495
 496 </dd></dl>
 497
 498 <dl class="function">
 499 <dt id="src.ElementTree.fromstring">
 500 <tt class="descclassname">src.ElementTree.</tt><tt class="descname">fromstring</tt><big>(</big><em>text</em><big>)</big><a class="headerlink" href="#src.ElementTree.fromstring" title="Permalink to this definition">¶</a></dt>
 501 <dd></dd></dl>
 502
 503 <dl class="function">
 504 <dt id="src.ElementTree.iselement">
 505 <tt class="descclassname">src.ElementTree.</tt><tt class="descname">iselement</tt><big>(</big><em>element</em><big>)</big><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>
 506 <dd></dd></dl>
 507
 508 <dl class="class">
 509 <dt id="src.ElementTree.iterparse">
 510 <em class="property">class </em><tt class="descclassname">src.ElementTree.</tt><tt class="descname">iterparse</tt><big>(</big><em>source</em>, <em>events=None</em><big>)</big><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>
 511 <dd><dl class="method">
 512 <dt id="src.ElementTree.iterparse.next">
 513 <tt class="descname">next</tt><big>(</big><big>)</big><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>
 514 <dd></dd></dl>
 515
 516 </dd></dl>
 517
 518 <dl class="function">
 519 <dt id="src.ElementTree.parse">
 520 <tt class="descclassname">src.ElementTree.</tt><tt class="descname">parse</tt><big>(</big><em>source</em>, <em>parser=None</em><big>)</big><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>
 521 <dd></dd></dl>
 522
 523 <dl class="function">
 524 <dt id="src.ElementTree.PI">
 525 <tt class="descclassname">src.ElementTree.</tt><tt class="descname">PI</tt><big>(</big><em>target</em>, <em>text=None</em><big>)</big><a class="headerlink" href="#src.ElementTree.PI" title="Permalink to this definition">¶</a></dt>
 526 <dd></dd></dl>
 527
 528 <dl class="function">
 529 <dt id="src.ElementTree.ProcessingInstruction">
 530 <tt class="descclassname">src.ElementTree.</tt><tt class="descname">ProcessingInstruction</tt><big>(</big><em>target</em>, <em>text=None</em><big>)</big><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>
 531 <dd></dd></dl>
 532
 533 <dl class="class">
 534 <dt id="src.ElementTree.QName">
 535 <em class="property">class </em><tt class="descclassname">src.ElementTree.</tt><tt class="descname">QName</tt><big>(</big><em>text_or_uri</em>, <em>tag=None</em><big>)</big><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>
 536 <dd></dd></dl>
 537
 538 <dl class="function">
 539 <dt id="src.ElementTree.SubElement">
 540 <tt class="descclassname">src.ElementTree.</tt><tt class="descname">SubElement</tt><big>(</big><em>parent</em>, <em>tag</em>, <em>attrib={}</em>, <em>**extra</em><big>)</big><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>
 541 <dd></dd></dl>
 542
 543 <dl class="function">
 544 <dt id="src.ElementTree.tostring">
 545 <tt class="descclassname">src.ElementTree.</tt><tt class="descname">tostring</tt><big>(</big><em>element</em>, <em>encoding=None</em><big>)</big><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>
 546 <dd></dd></dl>
 547
 548 <dl class="class">
 549 <dt id="src.ElementTree.TreeBuilder">
 550 <em class="property">class </em><tt class="descclassname">src.ElementTree.</tt><tt class="descname">TreeBuilder</tt><big>(</big><em>element_factory=None</em><big>)</big><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>
 551 <dd><dl class="method">
 552 <dt id="src.ElementTree.TreeBuilder.close">
 553 <tt class="descname">close</tt><big>(</big><big>)</big><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>
 554 <dd></dd></dl>
 555
 556 <dl class="method">
 557 <dt id="src.ElementTree.TreeBuilder.data">
 558 <tt class="descname">data</tt><big>(</big><em>data</em><big>)</big><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>
 559 <dd></dd></dl>
 560
 561 <dl class="method">
 562 <dt id="src.ElementTree.TreeBuilder.end">
 563 <tt class="descname">end</tt><big>(</big><em>tag</em><big>)</big><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>
 564 <dd></dd></dl>
 565
 566 <dl class="method">
 567 <dt id="src.ElementTree.TreeBuilder.start">
 568 <tt class="descname">start</tt><big>(</big><em>tag</em>, <em>attrs</em><big>)</big><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>
 569 <dd></dd></dl>
 570
 571 </dd></dl>
 572
 573 <dl class="function">
 574 <dt id="src.ElementTree.XML">
 575 <tt class="descclassname">src.ElementTree.</tt><tt class="descname">XML</tt><big>(</big><em>text</em><big>)</big><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>
 576 <dd></dd></dl>
 577
 578 <dl class="class">
 579 <dt id="src.ElementTree.XMLTreeBuilder">
 580 <em class="property">class </em><tt class="descclassname">src.ElementTree.</tt><tt class="descname">XMLTreeBuilder</tt><big>(</big><em>html=0</em>, <em>target=None</em><big>)</big><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>
 581 <dd><dl class="method">
 582 <dt id="src.ElementTree.XMLTreeBuilder.close">
 583 <tt class="descname">close</tt><big>(</big><big>)</big><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>
 584 <dd></dd></dl>
 585
 586 <dl class="method">
 587 <dt id="src.ElementTree.XMLTreeBuilder.doctype">
 588 <tt class="descname">doctype</tt><big>(</big><em>name</em>, <em>pubid</em>, <em>system</em><big>)</big><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>
 589 <dd></dd></dl>
 590
 591 <dl class="method">
 592 <dt id="src.ElementTree.XMLTreeBuilder.feed">
 593 <tt class="descname">feed</tt><big>(</big><em>data</em><big>)</big><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>
 594 <dd></dd></dl>
 595
 596 </dd></dl>
 597
 598 </div>
 599 <div class="section" id="module-src.architecture">
 600 <span id="architecture-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">architecture</span></tt> Module<a class="headerlink" href="#module-src.architecture" title="Permalink to this headline">¶</a></h2>
 601 <p>In this file : all the stuff that can change with the architecture
 602 on which SAT is running</p>
 603 <dl class="function">
 604 <dt id="src.architecture.get_distrib_version">
 605 <tt class="descclassname">src.architecture.</tt><tt class="descname">get_distrib_version</tt><big>(</big><em>distrib</em>, <em>codes</em><big>)</big><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>
 606 <dd><p>Gets the version of the distribution</p>
 607 <table class="docutils field-list" frame="void" rules="none">
 608 <col class="field-name" />
 609 <col class="field-body" />
 610 <tbody valign="top">
 611 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 612 <li><strong>str</strong> (<em>distrib</em>) -- The distribution on which the version will be found.</li>
 613 <li><strong>L{Mapping}</strong> (<em>codes</em>) -- The map containing distribution correlation table.</li>
 614 </ul>
 615 </td>
 616 </tr>
 617 <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,
 618 regarding the distribution correlation table contained in codes
 619 variable.</p>
 620 </td>
 621 </tr>
 622 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
 623 </td>
 624 </tr>
 625 </tbody>
 626 </table>
 627 </dd></dl>
 628
 629 <dl class="function">
 630 <dt id="src.architecture.get_distribution">
 631 <tt class="descclassname">src.architecture.</tt><tt class="descname">get_distribution</tt><big>(</big><em>codes</em><big>)</big><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>
 632 <dd><p>Gets the code for the distribution</p>
 633 <table class="docutils field-list" frame="void" rules="none">
 634 <col class="field-name" />
 635 <col class="field-body" />
 636 <tbody valign="top">
 637 <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>
 638 </tr>
 639 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The distribution on which salomeTools is running, regarding the
 640 distribution correlation table contained in codes variable.</td>
 641 </tr>
 642 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
 643 </tr>
 644 </tbody>
 645 </table>
 646 </dd></dl>
 647
 648 <dl class="function">
 649 <dt id="src.architecture.get_nb_proc">
 650 <tt class="descclassname">src.architecture.</tt><tt class="descname">get_nb_proc</tt><big>(</big><big>)</big><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>
 651 <dd><p>Gets the number of processors of the machine
 652 on which salomeTools is running.</p>
 653 <table class="docutils field-list" frame="void" rules="none">
 654 <col class="field-name" />
 655 <col class="field-body" />
 656 <tbody valign="top">
 657 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the number of processors.</td>
 658 </tr>
 659 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>
 660 </tr>
 661 </tbody>
 662 </table>
 663 </dd></dl>
 664
 665 <dl class="function">
 666 <dt id="src.architecture.get_python_version">
 667 <tt class="descclassname">src.architecture.</tt><tt class="descname">get_python_version</tt><big>(</big><big>)</big><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>
 668 <dd><p>Gets the version of the running python.</p>
 669 <table class="docutils field-list" frame="void" rules="none">
 670 <col class="field-name" />
 671 <col class="field-body" />
 672 <tbody valign="top">
 673 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the version of the running python.</td>
 674 </tr>
 675 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>
 676 </tr>
 677 </tbody>
 678 </table>
 679 </dd></dl>
 680
 681 <dl class="function">
 682 <dt id="src.architecture.get_user">
 683 <tt class="descclassname">src.architecture.</tt><tt class="descname">get_user</tt><big>(</big><big>)</big><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>
 684 <dd><p>method that gets the username that launched sat</p>
 685 <table class="docutils field-list" frame="void" rules="none">
 686 <col class="field-name" />
 687 <col class="field-body" />
 688 <tbody valign="top">
 689 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
 690 </tr>
 691 </tbody>
 692 </table>
 693 </dd></dl>
 694
 695 <dl class="function">
 696 <dt id="src.architecture.is_windows">
 697 <tt class="descclassname">src.architecture.</tt><tt class="descname">is_windows</tt><big>(</big><big>)</big><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>
 698 <dd><p>method that checks windows OS</p>
 699 <table class="docutils field-list" frame="void" rules="none">
 700 <col class="field-name" />
 701 <col class="field-body" />
 702 <tbody valign="top">
 703 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
 704 </tr>
 705 </tbody>
 706 </table>
 707 </dd></dl>
 708
 709 </div>
 710 <div class="section" id="module-src.compilation">
 711 <span id="compilation-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">compilation</span></tt> Module<a class="headerlink" href="#module-src.compilation" title="Permalink to this headline">¶</a></h2>
 712 <dl class="class">
 713 <dt id="src.compilation.Builder">
 714 <em class="property">class </em><tt class="descclassname">src.compilation.</tt><tt class="descname">Builder</tt><big>(</big><em>config</em>, <em>logger</em>, <em>product_info</em>, <em>options=&lt;src.options.OptResult object at 0x245afd0&gt;</em>, <em>check_src=True</em><big>)</big><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>
 715 <dd><p>Class to handle all construction steps, like cmake, configure, make, ...</p>
 716 <dl class="method">
 717 <dt id="src.compilation.Builder.build_configure">
 718 <tt class="descname">build_configure</tt><big>(</big><em>options=''</em><big>)</big><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>
 719 <dd></dd></dl>
 720
 721 <dl class="method">
 722 <dt id="src.compilation.Builder.check">
 723 <tt class="descname">check</tt><big>(</big><em>command=''</em><big>)</big><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>
 724 <dd></dd></dl>
 725
 726 <dl class="method">
 727 <dt id="src.compilation.Builder.cmake">
 728 <tt class="descname">cmake</tt><big>(</big><em>options=''</em><big>)</big><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>
 729 <dd></dd></dl>
 730
 731 <dl class="method">
 732 <dt id="src.compilation.Builder.complete_environment">
 733 <tt class="descname">complete_environment</tt><big>(</big><em>make_options</em><big>)</big><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>
 734 <dd></dd></dl>
 735
 736 <dl class="method">
 737 <dt id="src.compilation.Builder.configure">
 738 <tt class="descname">configure</tt><big>(</big><em>options=''</em><big>)</big><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>
 739 <dd></dd></dl>
 740
 741 <dl class="method">
 742 <dt id="src.compilation.Builder.do_batch_script_build">
 743 <tt class="descname">do_batch_script_build</tt><big>(</big><em>script</em>, <em>nb_proc</em><big>)</big><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>
 744 <dd></dd></dl>
 745
 746 <dl class="method">
 747 <dt id="src.compilation.Builder.do_default_build">
 748 <tt class="descname">do_default_build</tt><big>(</big><em>build_conf_options=''</em>, <em>configure_options=''</em>, <em>show_warning=True</em><big>)</big><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>
 749 <dd></dd></dl>
 750
 751 <dl class="method">
 752 <dt id="src.compilation.Builder.do_python_script_build">
 753 <tt class="descname">do_python_script_build</tt><big>(</big><em>script</em>, <em>nb_proc</em><big>)</big><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>
 754 <dd></dd></dl>
 755
 756 <dl class="method">
 757 <dt id="src.compilation.Builder.do_script_build">
 758 <tt class="descname">do_script_build</tt><big>(</big><em>script</em>, <em>number_of_proc=0</em><big>)</big><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>
 759 <dd></dd></dl>
 760
 761 <dl class="method">
 762 <dt id="src.compilation.Builder.hack_libtool">
 763 <tt class="descname">hack_libtool</tt><big>(</big><big>)</big><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>
 764 <dd></dd></dl>
 765
 766 <dl class="method">
 767 <dt id="src.compilation.Builder.install">
 768 <tt class="descname">install</tt><big>(</big><big>)</big><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>
 769 <dd></dd></dl>
 770
 771 <dl class="method">
 772 <dt id="src.compilation.Builder.log">
 773 <tt class="descname">log</tt><big>(</big><em>text</em>, <em>level</em>, <em>showInfo=True</em><big>)</big><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>
 774 <dd></dd></dl>
 775
 776 <dl class="method">
 777 <dt id="src.compilation.Builder.log_command">
 778 <tt class="descname">log_command</tt><big>(</big><em>command</em><big>)</big><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>
 779 <dd></dd></dl>
 780
 781 <dl class="method">
 782 <dt id="src.compilation.Builder.make">
 783 <tt class="descname">make</tt><big>(</big><em>nb_proc</em>, <em>make_opt=''</em><big>)</big><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>
 784 <dd></dd></dl>
 785
 786 <dl class="method">
 787 <dt id="src.compilation.Builder.prepare">
 788 <tt class="descname">prepare</tt><big>(</big><big>)</big><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>
 789 <dd></dd></dl>
 790
 791 <dl class="method">
 792 <dt id="src.compilation.Builder.put_txt_log_in_appli_log_dir">
 793 <tt class="descname">put_txt_log_in_appli_log_dir</tt><big>(</big><em>file_name</em><big>)</big><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>
 794 <dd><p>Put the txt log (that contain the system logs, like make command
 795 output) in the directory &lt;APPLICATION DIR&gt;/LOGS/&lt;product_name&gt;/</p>
 796 <table class="docutils field-list" frame="void" rules="none">
 797 <col class="field-name" />
 798 <col class="field-body" />
 799 <tbody valign="top">
 800 <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>
 801 </tr>
 802 </tbody>
 803 </table>
 804 </dd></dl>
 805
 806 <dl class="method">
 807 <dt id="src.compilation.Builder.wmake">
 808 <tt class="descname">wmake</tt><big>(</big><em>nb_proc</em>, <em>opt_nb_proc=None</em><big>)</big><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>
 809 <dd></dd></dl>
 810
 811 </dd></dl>
 812
 813 </div>
 814 <div class="section" id="module-src.debug">
 815 <span id="debug-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">debug</span></tt> Module<a class="headerlink" href="#module-src.debug" title="Permalink to this headline">¶</a></h2>
 816 <p>This file assume DEBUG functionalities use</p>
 817 <ul class="simple">
 818 <li>print debug messages in sys.stderr for salomeTools</li>
 819 <li>show pretty print debug representation from instances of SAT classes
 820 (pretty print src.pyconf.Config), and python dict/list etc. (as 'aVariable')</li>
 821 </ul>
 822 <p>WARNING: obviously supposedly show messages in SAT development phase, not production</p>
 823 <p>usage:
 824 &gt;&gt; import debug as DBG
 825 &gt;&gt; DBG.write(&quot;aTitle&quot;, aVariable)        # not shown in production
 826 &gt;&gt; DBG.write(&quot;aTitle&quot;, aVariable, True)  # unconditionaly shown (as show=True)</p>
 827 <p>to set show message as development phase:
 828 &gt;&gt; DBG.push_debug(True)</p>
 829 <p>to set no show message as production phase:
 830 &gt;&gt; DBG.push_debug(False)</p>
 831 <p>to set show message temporary as development phase, only in a method:
 832 &gt;&gt; def aMethodToDebug(...):
 833 &gt;&gt;   DBG.push_debug(True)              #force show as appended status
 834 &gt;&gt;   etc. method code with some DBG.write()
 835 &gt;&gt;   DBG.pop_debug()                   #restore previous status (show or not show)
 836 &gt;&gt;   return</p>
 837 <p>to set a message for future fix, as temporary problem to not forget:
 838 DBG.tofix(&quot;aTitle&quot;, aVariable, True/False) #True/False in production shown, or not</p>
 839 <p>in command line interface you could redirect stderr to file 'myDebug.log':
 840 &gt;&gt; sat compile ... 2&gt; myDebug.log   # only stderr
 841 &gt;&gt; sat compile ... &amp;&gt; myDebug.log   # stdout and stderr</p>
 842 <dl class="class">
 843 <dt id="src.debug.InStream">
 844 <em class="property">class </em><tt class="descclassname">src.debug.</tt><tt class="descname">InStream</tt><big>(</big><em>buf=''</em><big>)</big><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>
 845 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">StringIO.StringIO</span></tt></p>
 846 <p>utility class for pyconf.Config input iostream</p>
 847 </dd></dl>
 848
 849 <dl class="class">
 850 <dt id="src.debug.OutStream">
 851 <em class="property">class </em><tt class="descclassname">src.debug.</tt><tt class="descname">OutStream</tt><big>(</big><em>buf=''</em><big>)</big><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>
 852 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">StringIO.StringIO</span></tt></p>
 853 <p>utility class for pyconf.Config output iostream</p>
 854 <dl class="method">
 855 <dt id="src.debug.OutStream.close">
 856 <tt class="descname">close</tt><big>(</big><big>)</big><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>
 857 <dd><p>because Config.__save__ calls close() stream as file
 858 keep value before lost as self.value</p>
 859 </dd></dl>
 860
 861 </dd></dl>
 862
 863 <dl class="function">
 864 <dt id="src.debug.getLocalEnv">
 865 <tt class="descclassname">src.debug.</tt><tt class="descname">getLocalEnv</tt><big>(</big><big>)</big><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>
 866 <dd><p>get string for environment variables representation</p>
 867 </dd></dl>
 868
 869 <dl class="function">
 870 <dt id="src.debug.getStrConfigDbg">
 871 <tt class="descclassname">src.debug.</tt><tt class="descname">getStrConfigDbg</tt><big>(</big><em>config</em><big>)</big><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>
 872 <dd><p>set string as saveConfigDbg,
 873 as (path expression evaluation) for debug</p>
 874 </dd></dl>
 875
 876 <dl class="function">
 877 <dt id="src.debug.getStrConfigStd">
 878 <tt class="descclassname">src.debug.</tt><tt class="descname">getStrConfigStd</tt><big>(</big><em>config</em><big>)</big><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>
 879 <dd><p>set string as saveConfigStd, as file .pyconf</p>
 880 </dd></dl>
 881
 882 <dl class="function">
 883 <dt id="src.debug.indent">
 884 <tt class="descclassname">src.debug.</tt><tt class="descname">indent</tt><big>(</big><em>text</em>, <em>amount=2</em>, <em>ch=' '</em><big>)</big><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>
 885 <dd><p>indent multi lines message</p>
 886 </dd></dl>
 887
 888 <dl class="function">
 889 <dt id="src.debug.pop_debug">
 890 <tt class="descclassname">src.debug.</tt><tt class="descname">pop_debug</tt><big>(</big><big>)</big><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>
 891 <dd><p>restore previous debug outputs status</p>
 892 </dd></dl>
 893
 894 <dl class="function">
 895 <dt id="src.debug.push_debug">
 896 <tt class="descclassname">src.debug.</tt><tt class="descname">push_debug</tt><big>(</big><em>aBool</em><big>)</big><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>
 897 <dd><p>set debug outputs activated, or not</p>
 898 </dd></dl>
 899
 900 <dl class="function">
 901 <dt id="src.debug.saveConfigDbg">
 902 <tt class="descclassname">src.debug.</tt><tt class="descname">saveConfigDbg</tt><big>(</big><em>config</em>, <em>aStream</em>, <em>indent=0</em>, <em>path=''</em><big>)</big><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>
 903 <dd><p>pyconf returns multilines (path expression evaluation) for debug</p>
 904 </dd></dl>
 905
 906 <dl class="function">
 907 <dt id="src.debug.saveConfigStd">
 908 <tt class="descclassname">src.debug.</tt><tt class="descname">saveConfigStd</tt><big>(</big><em>config</em>, <em>aStream</em><big>)</big><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>
 909 <dd><p>returns as file .pyconf</p>
 910 </dd></dl>
 911
 912 <dl class="function">
 913 <dt id="src.debug.tofix">
 914 <tt class="descclassname">src.debug.</tt><tt class="descname">tofix</tt><big>(</big><em>title</em>, <em>var=''</em>, <em>force=None</em><big>)</big><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>
 915 <dd><p>write sys.stderr a message if _debug[-1]==True or optionaly force=True
 916 use this only if no logger accessible for classic
 917 logger.warning(message) or logger.debug(message)</p>
 918 </dd></dl>
 919
 920 <dl class="function">
 921 <dt id="src.debug.write">
 922 <tt class="descclassname">src.debug.</tt><tt class="descname">write</tt><big>(</big><em>title</em>, <em>var=''</em>, <em>force=None</em>, <em>fmt='\n#### DEBUG: %s:\n%s\n'</em><big>)</big><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>
 923 <dd><p>write sys.stderr a message if _debug[-1]==True or optionaly force=True</p>
 924 </dd></dl>
 925
 926 </div>
 927 <div class="section" id="module-src.environment">
 928 <span id="environment-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">environment</span></tt> Module<a class="headerlink" href="#module-src.environment" title="Permalink to this headline">¶</a></h2>
 929 <dl class="class">
 930 <dt id="src.environment.Environ">
 931 <em class="property">class </em><tt class="descclassname">src.environment.</tt><tt class="descname">Environ</tt><big>(</big><em>environ=None</em><big>)</big><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>
 932 <dd><p>Class to manage the environment context</p>
 933 <dl class="method">
 934 <dt id="src.environment.Environ.append">
 935 <tt class="descname">append</tt><big>(</big><em>key</em>, <em>value</em>, <em>sep=':'</em><big>)</big><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>
 936 <dd><p>Same as append_value but the value argument can be a list</p>
 937 <table class="docutils field-list" frame="void" rules="none">
 938 <col class="field-name" />
 939 <col class="field-body" />
 940 <tbody valign="top">
 941 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 942 <li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
 943 <li><strong>str or list</strong> (<em>value</em>) -- the value(s) to append to key</li>
 944 <li><strong>str</strong> -- the separator string</li>
 945 </ul>
 946 </td>
 947 </tr>
 948 </tbody>
 949 </table>
 950 </dd></dl>
 951
 952 <dl class="method">
 953 <dt id="src.environment.Environ.append_value">
 954 <tt class="descname">append_value</tt><big>(</big><em>key</em>, <em>value</em>, <em>sep=':'</em><big>)</big><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>
 955 <dd><p>append value to key using sep</p>
 956 <table class="docutils field-list" frame="void" rules="none">
 957 <col class="field-name" />
 958 <col class="field-body" />
 959 <tbody valign="top">
 960 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 961 <li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
 962 <li><strong>str</strong> -- the value to append to key</li>
 963 <li><strong>str</strong> -- the separator string</li>
 964 </ul>
 965 </td>
 966 </tr>
 967 </tbody>
 968 </table>
 969 </dd></dl>
 970
 971 <dl class="method">
 972 <dt id="src.environment.Environ.command_value">
 973 <tt class="descname">command_value</tt><big>(</big><em>key</em>, <em>command</em><big>)</big><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>
 974 <dd><p>Get the value given by the system command &quot;command&quot;
 975 and put it in the environment variable key</p>
 976 <table class="docutils field-list" frame="void" rules="none">
 977 <col class="field-name" />
 978 <col class="field-body" />
 979 <tbody valign="top">
 980 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 981 <li><strong>str</strong> (<em>command</em>) -- the environment variable</li>
 982 <li><strong>str</strong> -- the command to execute</li>
 983 </ul>
 984 </td>
 985 </tr>
 986 </tbody>
 987 </table>
 988 </dd></dl>
 989
 990 <dl class="method">
 991 <dt id="src.environment.Environ.get">
 992 <tt class="descname">get</tt><big>(</big><em>key</em><big>)</big><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>
 993 <dd><p>Get the value of the environment variable &quot;key&quot;</p>
 994 <table class="docutils field-list" frame="void" rules="none">
 995 <col class="field-name" />
 996 <col class="field-body" />
 997 <tbody valign="top">
 998 <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>
 999 </tr>
1000 </tbody>
1001 </table>
1002 </dd></dl>
1003
1004 <dl class="method">
1005 <dt id="src.environment.Environ.is_defined">
1006 <tt class="descname">is_defined</tt><big>(</big><em>key</em><big>)</big><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>
1007 <dd><p>Check if the key exists in the environment</p>
1008 <table class="docutils field-list" frame="void" rules="none">
1009 <col class="field-name" />
1010 <col class="field-body" />
1011 <tbody valign="top">
1012 <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>
1013 </tr>
1014 </tbody>
1015 </table>
1016 </dd></dl>
1017
1018 <dl class="method">
1019 <dt id="src.environment.Environ.prepend">
1020 <tt class="descname">prepend</tt><big>(</big><em>key</em>, <em>value</em>, <em>sep=':'</em><big>)</big><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>
1021 <dd><p>Same as prepend_value but the value argument can be a list</p>
1022 <table class="docutils field-list" frame="void" rules="none">
1023 <col class="field-name" />
1024 <col class="field-body" />
1025 <tbody valign="top">
1026 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1027 <li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
1028 <li><strong>str or list</strong> (<em>value</em>) -- the value(s) to prepend to key</li>
1029 <li><strong>str</strong> -- the separator string</li>
1030 </ul>
1031 </td>
1032 </tr>
1033 </tbody>
1034 </table>
1035 </dd></dl>
1036
1037 <dl class="method">
1038 <dt id="src.environment.Environ.prepend_value">
1039 <tt class="descname">prepend_value</tt><big>(</big><em>key</em>, <em>value</em>, <em>sep=':'</em><big>)</big><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>
1040 <dd><p>prepend value to key using sep</p>
1041 <table class="docutils field-list" frame="void" rules="none">
1042 <col class="field-name" />
1043 <col class="field-body" />
1044 <tbody valign="top">
1045 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1046 <li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
1047 <li><strong>str</strong> -- the value to prepend to key</li>
1048 <li><strong>str</strong> -- the separator string</li>
1049 </ul>
1050 </td>
1051 </tr>
1052 </tbody>
1053 </table>
1054 </dd></dl>
1055
1056 <dl class="method">
1057 <dt id="src.environment.Environ.set">
1058 <tt class="descname">set</tt><big>(</big><em>key</em>, <em>value</em><big>)</big><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>
1059 <dd><p>Set the environment variable &quot;key&quot; to value &quot;value&quot;</p>
1060 <table class="docutils field-list" frame="void" rules="none">
1061 <col class="field-name" />
1062 <col class="field-body" />
1063 <tbody valign="top">
1064 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1065 <li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
1066 <li><strong>str</strong> -- the value</li>
1067 </ul>
1068 </td>
1069 </tr>
1070 </tbody>
1071 </table>
1072 </dd></dl>
1073
1074 </dd></dl>
1075
1076 <dl class="class">
1077 <dt id="src.environment.FileEnvWriter">
1078 <em class="property">class </em><tt class="descclassname">src.environment.</tt><tt class="descname">FileEnvWriter</tt><big>(</big><em>config</em>, <em>logger</em>, <em>out_dir</em>, <em>src_root</em>, <em>env_info=None</em><big>)</big><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>
1079 <dd><p>Class to dump the environment to a file.</p>
1080 <dl class="method">
1081 <dt id="src.environment.FileEnvWriter.write_cfgForPy_file">
1082 <tt class="descname">write_cfgForPy_file</tt><big>(</big><em>filename</em>, <em>additional_env={}</em>, <em>for_package=None</em>, <em>with_commercial=True</em><big>)</big><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>
1083 <dd><p>Append to current opened aFile a cfgForPy
1084 environment (SALOME python launcher).</p>
1085 <table class="docutils field-list" frame="void" rules="none">
1086 <col class="field-name" />
1087 <col class="field-body" />
1088 <tbody valign="top">
1089 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1090 <li><strong>str</strong> (<em>for_package</em>) -- the file path</li>
1091 <li><strong>dict</strong> (<em>additional_env</em>) -- a dictionary of additional variables
1092 to add to the environment</li>
1093 <li><strong>str</strong> -- If not None, produce a relative environment
1094 designed for a package.</li>
1095 </ul>
1096 </td>
1097 </tr>
1098 </tbody>
1099 </table>
1100 </dd></dl>
1101
1102 <dl class="method">
1103 <dt id="src.environment.FileEnvWriter.write_env_file">
1104 <tt class="descname">write_env_file</tt><big>(</big><em>filename</em>, <em>forBuild</em>, <em>shell</em>, <em>for_package=None</em><big>)</big><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>
1105 <dd><p>Create an environment file.</p>
1106 <table class="docutils field-list" frame="void" rules="none">
1107 <col class="field-name" />
1108 <col class="field-body" />
1109 <tbody valign="top">
1110 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
1111 <li><strong>str</strong> (<em>shell</em>) -- the file path</li>
1112 <li><strong>bool</strong> (<em>forBuild</em>) -- if true, the build environment</li>
1113 <li><strong>str</strong> -- the type of file wanted (.sh, .bat)</li>
1114 </ul>
1115 </td>
1116 </tr>
1117 <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>
1118 </td>
1119 </tr>
1120 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
1121 </td>
1122 </tr>
1123 </tbody>
1124 </table>
1125 </dd></dl>
1126
1127 </dd></dl>
1128
1129 <dl class="class">
1130 <dt id="src.environment.SalomeEnviron">
1131 <em class="property">class </em><tt class="descclassname">src.environment.</tt><tt class="descname">SalomeEnviron</tt><big>(</big><em>cfg</em>, <em>environ</em>, <em>forBuild=False</em>, <em>for_package=None</em>, <em>enable_simple_env_script=True</em><big>)</big><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>
1132 <dd><p>Class to manage the environment of SALOME.</p>
1133 <dl class="method">
1134 <dt id="src.environment.SalomeEnviron.add_comment">
1135 <tt class="descname">add_comment</tt><big>(</big><em>comment</em><big>)</big><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>
1136 <dd><p>Add a commentary to the out stream (in case of file generation)</p>
1137 <table class="docutils field-list" frame="void" rules="none">
1138 <col class="field-name" />
1139 <col class="field-body" />
1140 <tbody valign="top">
1141 <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>
1142 </tr>
1143 </tbody>
1144 </table>
1145 </dd></dl>
1146
1147 <dl class="method">
1148 <dt id="src.environment.SalomeEnviron.add_line">
1149 <tt class="descname">add_line</tt><big>(</big><em>nb_line</em><big>)</big><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>
1150 <dd><p>Add empty lines to the out stream (in case of file generation)</p>
1151 <table class="docutils field-list" frame="void" rules="none">
1152 <col class="field-name" />
1153 <col class="field-body" />
1154 <tbody valign="top">
1155 <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>
1156 </tr>
1157 </tbody>
1158 </table>
1159 </dd></dl>
1160
1161 <dl class="method">
1162 <dt id="src.environment.SalomeEnviron.add_warning">
1163 <tt class="descname">add_warning</tt><big>(</big><em>warning</em><big>)</big><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>
1164 <dd><p>Add a warning to the out stream (in case of file generation)</p>
1165 <table class="docutils field-list" frame="void" rules="none">
1166 <col class="field-name" />
1167 <col class="field-body" />
1168 <tbody valign="top">
1169 <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>
1170 </tr>
1171 </tbody>
1172 </table>
1173 </dd></dl>
1174
1175 <dl class="method">
1176 <dt id="src.environment.SalomeEnviron.append">
1177 <tt class="descname">append</tt><big>(</big><em>key</em>, <em>value</em>, <em>sep=':'</em><big>)</big><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>
1178 <dd><p>append value to key using sep</p>
1179 <table class="docutils field-list" frame="void" rules="none">
1180 <col class="field-name" />
1181 <col class="field-body" />
1182 <tbody valign="top">
1183 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1184 <li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
1185 <li><strong>str</strong> -- the value to append to key</li>
1186 <li><strong>str</strong> -- the separator string</li>
1187 </ul>
1188 </td>
1189 </tr>
1190 </tbody>
1191 </table>
1192 </dd></dl>
1193
1194 <dl class="method">
1195 <dt id="src.environment.SalomeEnviron.dump">
1196 <tt class="descname">dump</tt><big>(</big><em>out</em><big>)</big><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>
1197 <dd><p>Write the environment to out</p>
1198 <table class="docutils field-list" frame="void" rules="none">
1199 <col class="field-name" />
1200 <col class="field-body" />
1201 <tbody valign="top">
1202 <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>
1203 </tr>
1204 </tbody>
1205 </table>
1206 </dd></dl>
1207
1208 <dl class="method">
1209 <dt id="src.environment.SalomeEnviron.finish">
1210 <tt class="descname">finish</tt><big>(</big><em>required</em><big>)</big><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>
1211 <dd><p>Add a final instruction in the out file (in case of file generation)</p>
1212 <table class="docutils field-list" frame="void" rules="none">
1213 <col class="field-name" />
1214 <col class="field-body" />
1215 <tbody valign="top">
1216 <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>
1217 </tr>
1218 </tbody>
1219 </table>
1220 </dd></dl>
1221
1222 <dl class="method">
1223 <dt id="src.environment.SalomeEnviron.get">
1224 <tt class="descname">get</tt><big>(</big><em>key</em><big>)</big><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>
1225 <dd><p>Get the value of the environment variable &quot;key&quot;</p>
1226 <table class="docutils field-list" frame="void" rules="none">
1227 <col class="field-name" />
1228 <col class="field-body" />
1229 <tbody valign="top">
1230 <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>
1231 </tr>
1232 </tbody>
1233 </table>
1234 </dd></dl>
1235
1236 <dl class="method">
1237 <dt id="src.environment.SalomeEnviron.get_names">
1238 <tt class="descname">get_names</tt><big>(</big><em>lProducts</em><big>)</big><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>
1239 <dd><p>Get the products name to add in SALOME_MODULES environment variable
1240 It is the name of the product, except in the case where the is a
1241 component name. And it has to be in SALOME_MODULES variable only
1242 if the product has the property has_salome_hui = &quot;yes&quot;</p>
1243 <table class="docutils field-list" frame="void" rules="none">
1244 <col class="field-name" />
1245 <col class="field-body" />
1246 <tbody valign="top">
1247 <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>
1248 </tr>
1249 </tbody>
1250 </table>
1251 </dd></dl>
1252
1253 <dl class="method">
1254 <dt id="src.environment.SalomeEnviron.is_defined">
1255 <tt class="descname">is_defined</tt><big>(</big><em>key</em><big>)</big><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>
1256 <dd><p>Check if the key exists in the environment</p>
1257 <table class="docutils field-list" frame="void" rules="none">
1258 <col class="field-name" />
1259 <col class="field-body" />
1260 <tbody valign="top">
1261 <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>
1262 </tr>
1263 </tbody>
1264 </table>
1265 </dd></dl>
1266
1267 <dl class="method">
1268 <dt id="src.environment.SalomeEnviron.load_cfg_environment">
1269 <tt class="descname">load_cfg_environment</tt><big>(</big><em>cfg_env</em><big>)</big><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>
1270 <dd><p>Loads environment defined in cfg_env</p>
1271 <table class="docutils field-list" frame="void" rules="none">
1272 <col class="field-name" />
1273 <col class="field-body" />
1274 <tbody valign="top">
1275 <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>
1276 </tr>
1277 </tbody>
1278 </table>
1279 </dd></dl>
1280
1281 <dl class="method">
1282 <dt id="src.environment.SalomeEnviron.prepend">
1283 <tt class="descname">prepend</tt><big>(</big><em>key</em>, <em>value</em>, <em>sep=':'</em><big>)</big><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>
1284 <dd><p>prepend value to key using sep</p>
1285 <table class="docutils field-list" frame="void" rules="none">
1286 <col class="field-name" />
1287 <col class="field-body" />
1288 <tbody valign="top">
1289 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1290 <li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
1291 <li><strong>str</strong> -- the value to prepend to key</li>
1292 <li><strong>str</strong> -- the separator string</li>
1293 </ul>
1294 </td>
1295 </tr>
1296 </tbody>
1297 </table>
1298 </dd></dl>
1299
1300 <dl class="method">
1301 <dt id="src.environment.SalomeEnviron.run_env_script">
1302 <tt class="descname">run_env_script</tt><big>(</big><em>product_info</em>, <em>logger=None</em>, <em>native=False</em><big>)</big><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>
1303 <dd><p>Runs an environment script.</p>
1304 <table class="docutils field-list" frame="void" rules="none">
1305 <col class="field-name" />
1306 <col class="field-body" />
1307 <tbody valign="top">
1308 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1309 <li><strong>Config</strong> (<em>product_info</em>) -- The product description</li>
1310 <li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
1311 <li><strong>Boolean</strong> (<em>native</em>) -- if True load set_native_env instead of set_env</li>
1312 </ul>
1313 </td>
1314 </tr>
1315 </tbody>
1316 </table>
1317 </dd></dl>
1318
1319 <dl class="method">
1320 <dt id="src.environment.SalomeEnviron.run_simple_env_script">
1321 <tt class="descname">run_simple_env_script</tt><big>(</big><em>script_path</em>, <em>logger=None</em><big>)</big><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>
1322 <dd><p>Runs an environment script. Same as run_env_script, but with a
1323 script path as parameter.</p>
1324 <table class="docutils field-list" frame="void" rules="none">
1325 <col class="field-name" />
1326 <col class="field-body" />
1327 <tbody valign="top">
1328 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1329 <li><strong>str</strong> (<em>script_path</em>) -- a path to an environment script</li>
1330 <li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
1331 </ul>
1332 </td>
1333 </tr>
1334 </tbody>
1335 </table>
1336 </dd></dl>
1337
1338 <dl class="method">
1339 <dt id="src.environment.SalomeEnviron.set">
1340 <tt class="descname">set</tt><big>(</big><em>key</em>, <em>value</em><big>)</big><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>
1341 <dd><p>Set the environment variable &quot;key&quot; to value &quot;value&quot;</p>
1342 <table class="docutils field-list" frame="void" rules="none">
1343 <col class="field-name" />
1344 <col class="field-body" />
1345 <tbody valign="top">
1346 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1347 <li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
1348 <li><strong>str</strong> -- the value</li>
1349 </ul>
1350 </td>
1351 </tr>
1352 </tbody>
1353 </table>
1354 </dd></dl>
1355
1356 <dl class="method">
1357 <dt id="src.environment.SalomeEnviron.set_a_product">
1358 <tt class="descname">set_a_product</tt><big>(</big><em>product</em>, <em>logger</em><big>)</big><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>
1359 <dd><p>Sets the environment of a product.</p>
1360 <table class="docutils field-list" frame="void" rules="none">
1361 <col class="field-name" />
1362 <col class="field-body" />
1363 <tbody valign="top">
1364 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1365 <li><strong>str</strong> (<em>product</em>) -- The product name</li>
1366 <li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
1367 </ul>
1368 </td>
1369 </tr>
1370 </tbody>
1371 </table>
1372 </dd></dl>
1373
1374 <dl class="method">
1375 <dt id="src.environment.SalomeEnviron.set_application_env">
1376 <tt class="descname">set_application_env</tt><big>(</big><em>logger</em><big>)</big><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>
1377 <dd><p>Sets the environment defined in the APPLICATION file.</p>
1378 <table class="docutils field-list" frame="void" rules="none">
1379 <col class="field-name" />
1380 <col class="field-body" />
1381 <tbody valign="top">
1382 <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>
1383 </tr>
1384 </tbody>
1385 </table>
1386 </dd></dl>
1387
1388 <dl class="method">
1389 <dt id="src.environment.SalomeEnviron.set_cpp_env">
1390 <tt class="descname">set_cpp_env</tt><big>(</big><em>product_info</em><big>)</big><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>
1391 <dd><p>Sets the generic environment for a SALOME cpp product.</p>
1392 <table class="docutils field-list" frame="void" rules="none">
1393 <col class="field-name" />
1394 <col class="field-body" />
1395 <tbody valign="top">
1396 <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>
1397 </tr>
1398 </tbody>
1399 </table>
1400 </dd></dl>
1401
1402 <dl class="method">
1403 <dt id="src.environment.SalomeEnviron.set_full_environ">
1404 <tt class="descname">set_full_environ</tt><big>(</big><em>logger</em>, <em>env_info</em><big>)</big><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>
1405 <dd><p>Sets the full environment for products
1406 specified in env_info dictionary.</p>
1407 <table class="docutils field-list" frame="void" rules="none">
1408 <col class="field-name" />
1409 <col class="field-body" />
1410 <tbody valign="top">
1411 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1412 <li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
1413 <li><strong>list</strong> (<em>env_info</em>) -- the list of products</li>
1414 </ul>
1415 </td>
1416 </tr>
1417 </tbody>
1418 </table>
1419 </dd></dl>
1420
1421 <dl class="method">
1422 <dt id="src.environment.SalomeEnviron.set_products">
1423 <tt class="descname">set_products</tt><big>(</big><em>logger</em>, <em>src_root=None</em><big>)</big><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>
1424 <dd><p>Sets the environment for all the products.</p>
1425 <table class="docutils field-list" frame="void" rules="none">
1426 <col class="field-name" />
1427 <col class="field-body" />
1428 <tbody valign="top">
1429 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1430 <li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
1431 <li><strong>src</strong> (<em>src_root</em>) -- the application working directory</li>
1432 </ul>
1433 </td>
1434 </tr>
1435 </tbody>
1436 </table>
1437 </dd></dl>
1438
1439 <dl class="method">
1440 <dt id="src.environment.SalomeEnviron.set_python_libdirs">
1441 <tt class="descname">set_python_libdirs</tt><big>(</big><big>)</big><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>
1442 <dd><p>Set some generic variables for python library paths</p>
1443 </dd></dl>
1444
1445 <dl class="method">
1446 <dt id="src.environment.SalomeEnviron.set_salome_generic_product_env">
1447 <tt class="descname">set_salome_generic_product_env</tt><big>(</big><em>pi</em><big>)</big><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>
1448 <dd><p>Sets the generic environment for a SALOME product.</p>
1449 <table class="docutils field-list" frame="void" rules="none">
1450 <col class="field-name" />
1451 <col class="field-body" />
1452 <tbody valign="top">
1453 <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>
1454 </tr>
1455 </tbody>
1456 </table>
1457 </dd></dl>
1458
1459 <dl class="method">
1460 <dt id="src.environment.SalomeEnviron.set_salome_minimal_product_env">
1461 <tt class="descname">set_salome_minimal_product_env</tt><big>(</big><em>product_info</em>, <em>logger</em><big>)</big><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>
1462 <dd><p>Sets the minimal environment for a SALOME product.
1463 xxx_ROOT_DIR and xxx_SRC_DIR</p>
1464 <table class="docutils field-list" frame="void" rules="none">
1465 <col class="field-name" />
1466 <col class="field-body" />
1467 <tbody valign="top">
1468 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1469 <li><strong>Config</strong> (<em>product_info</em>) -- The product description</li>
1470 <li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
1471 </ul>
1472 </td>
1473 </tr>
1474 </tbody>
1475 </table>
1476 </dd></dl>
1477
1478 </dd></dl>
1479
1480 <dl class="class">
1481 <dt id="src.environment.Shell">
1482 <em class="property">class </em><tt class="descclassname">src.environment.</tt><tt class="descname">Shell</tt><big>(</big><em>name</em>, <em>extension</em><big>)</big><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>
1483 <dd><p>Definition of a Shell.</p>
1484 </dd></dl>
1485
1486 <dl class="function">
1487 <dt id="src.environment.load_environment">
1488 <tt class="descclassname">src.environment.</tt><tt class="descname">load_environment</tt><big>(</big><em>config</em>, <em>build</em>, <em>logger</em><big>)</big><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>
1489 <dd><p>Loads the environment (used to run the tests, for example).</p>
1490 <table class="docutils field-list" frame="void" rules="none">
1491 <col class="field-name" />
1492 <col class="field-body" />
1493 <tbody valign="top">
1494 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1495 <li><strong>Config</strong> (<em>config</em>) -- the global config</li>
1496 <li><strong>bool</strong> (<em>build</em>) -- build environement if True</li>
1497 <li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to display messages</li>
1498 </ul>
1499 </td>
1500 </tr>
1501 </tbody>
1502 </table>
1503 </dd></dl>
1504
1505 </div>
1506 <div class="section" id="module-src.fileEnviron">
1507 <span id="fileenviron-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">fileEnviron</span></tt> Module<a class="headerlink" href="#module-src.fileEnviron" title="Permalink to this headline">¶</a></h2>
1508 <dl class="class">
1509 <dt id="src.fileEnviron.BashFileEnviron">
1510 <em class="property">class </em><tt class="descclassname">src.fileEnviron.</tt><tt class="descname">BashFileEnviron</tt><big>(</big><em>output</em>, <em>environ=None</em><big>)</big><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>
1511 <dd><p>Bases: <a class="reference internal" href="#src.fileEnviron.FileEnviron" title="src.fileEnviron.FileEnviron"><tt class="xref py py-class docutils literal"><span class="pre">src.fileEnviron.FileEnviron</span></tt></a></p>
1512 <p>Class for bash shell.</p>
1513 <dl class="method">
1514 <dt id="src.fileEnviron.BashFileEnviron.command_value">
1515 <tt class="descname">command_value</tt><big>(</big><em>key</em>, <em>command</em><big>)</big><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>
1516 <dd><p>Get the value given by the system command &quot;command&quot;
1517 and put it in the environment variable key.
1518 Has to be overwritten in the derived classes
1519 This can be seen as a virtual method</p>
1520 <table class="docutils field-list" frame="void" rules="none">
1521 <col class="field-name" />
1522 <col class="field-body" />
1523 <tbody valign="top">
1524 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1525 <li><strong>str</strong> (<em>command</em>) -- the environment variable</li>
1526 <li><strong>str</strong> -- the command to execute</li>
1527 </ul>
1528 </td>
1529 </tr>
1530 </tbody>
1531 </table>
1532 </dd></dl>
1533
1534 <dl class="method">
1535 <dt id="src.fileEnviron.BashFileEnviron.finish">
1536 <tt class="descname">finish</tt><big>(</big><em>required=True</em><big>)</big><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>
1537 <dd><p>Add a final instruction in the out file (in case of file generation)</p>
1538 <table class="docutils field-list" frame="void" rules="none">
1539 <col class="field-name" />
1540 <col class="field-body" />
1541 <tbody valign="top">
1542 <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>
1543 </tr>
1544 </tbody>
1545 </table>
1546 </dd></dl>
1547
1548 <dl class="method">
1549 <dt id="src.fileEnviron.BashFileEnviron.set">
1550 <tt class="descname">set</tt><big>(</big><em>key</em>, <em>value</em><big>)</big><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>
1551 <dd><p>Set the environment variable &quot;key&quot; to value &quot;value&quot;</p>
1552 <table class="docutils field-list" frame="void" rules="none">
1553 <col class="field-name" />
1554 <col class="field-body" />
1555 <tbody valign="top">
1556 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1557 <li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
1558 <li><strong>str</strong> -- the value</li>
1559 </ul>
1560 </td>
1561 </tr>
1562 </tbody>
1563 </table>
1564 </dd></dl>
1565
1566 </dd></dl>
1567
1568 <dl class="class">
1569 <dt id="src.fileEnviron.BatFileEnviron">
1570 <em class="property">class </em><tt class="descclassname">src.fileEnviron.</tt><tt class="descname">BatFileEnviron</tt><big>(</big><em>output</em>, <em>environ=None</em><big>)</big><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>
1571 <dd><p>Bases: <a class="reference internal" href="#src.fileEnviron.FileEnviron" title="src.fileEnviron.FileEnviron"><tt class="xref py py-class docutils literal"><span class="pre">src.fileEnviron.FileEnviron</span></tt></a></p>
1572 <p>for Windows batch shell.</p>
1573 <dl class="method">
1574 <dt id="src.fileEnviron.BatFileEnviron.add_comment">
1575 <tt class="descname">add_comment</tt><big>(</big><em>comment</em><big>)</big><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>
1576 <dd><p>Add a comment in the shell file</p>
1577 <table class="docutils field-list" frame="void" rules="none">
1578 <col class="field-name" />
1579 <col class="field-body" />
1580 <tbody valign="top">
1581 <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>
1582 </tr>
1583 </tbody>
1584 </table>
1585 </dd></dl>
1586
1587 <dl class="method">
1588 <dt id="src.fileEnviron.BatFileEnviron.command_value">
1589 <tt class="descname">command_value</tt><big>(</big><em>key</em>, <em>command</em><big>)</big><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>
1590 <dd><p>Get the value given by the system command &quot;command&quot;
1591 and put it in the environment variable key.
1592 Has to be overwritten in the derived classes
1593 This can be seen as a virtual method</p>
1594 <table class="docutils field-list" frame="void" rules="none">
1595 <col class="field-name" />
1596 <col class="field-body" />
1597 <tbody valign="top">
1598 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1599 <li><strong>str</strong> (<em>command</em>) -- the environment variable</li>
1600 <li><strong>str</strong> -- the command to execute</li>
1601 </ul>
1602 </td>
1603 </tr>
1604 </tbody>
1605 </table>
1606 </dd></dl>
1607
1608 <dl class="method">
1609 <dt id="src.fileEnviron.BatFileEnviron.finish">
1610 <tt class="descname">finish</tt><big>(</big><em>required=True</em><big>)</big><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>
1611 <dd><p>Add a final instruction in the out file (in case of file generation)
1612 In the particular windows case, do nothing</p>
1613 <table class="docutils field-list" frame="void" rules="none">
1614 <col class="field-name" />
1615 <col class="field-body" />
1616 <tbody valign="top">
1617 <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>
1618 </tr>
1619 </tbody>
1620 </table>
1621 </dd></dl>
1622
1623 <dl class="method">
1624 <dt id="src.fileEnviron.BatFileEnviron.get">
1625 <tt class="descname">get</tt><big>(</big><em>key</em><big>)</big><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>
1626 <dd><p>Get the value of the environment variable &quot;key&quot;</p>
1627 <table class="docutils field-list" frame="void" rules="none">
1628 <col class="field-name" />
1629 <col class="field-body" />
1630 <tbody valign="top">
1631 <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>
1632 </tr>
1633 </tbody>
1634 </table>
1635 </dd></dl>
1636
1637 <dl class="method">
1638 <dt id="src.fileEnviron.BatFileEnviron.set">
1639 <tt class="descname">set</tt><big>(</big><em>key</em>, <em>value</em><big>)</big><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>
1640 <dd><p>Set the environment variable &quot;key&quot; to value &quot;value&quot;</p>
1641 <table class="docutils field-list" frame="void" rules="none">
1642 <col class="field-name" />
1643 <col class="field-body" />
1644 <tbody valign="top">
1645 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1646 <li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
1647 <li><strong>str</strong> -- the value</li>
1648 </ul>
1649 </td>
1650 </tr>
1651 </tbody>
1652 </table>
1653 </dd></dl>
1654
1655 </dd></dl>
1656
1657 <dl class="class">
1658 <dt id="src.fileEnviron.ContextFileEnviron">
1659 <em class="property">class </em><tt class="descclassname">src.fileEnviron.</tt><tt class="descname">ContextFileEnviron</tt><big>(</big><em>output</em>, <em>environ=None</em><big>)</big><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>
1660 <dd><p>Bases: <a class="reference internal" href="#src.fileEnviron.FileEnviron" title="src.fileEnviron.FileEnviron"><tt class="xref py py-class docutils literal"><span class="pre">src.fileEnviron.FileEnviron</span></tt></a></p>
1661 <p>Class for a salome context configuration file.</p>
1662 <dl class="method">
1663 <dt id="src.fileEnviron.ContextFileEnviron.add_echo">
1664 <tt class="descname">add_echo</tt><big>(</big><em>text</em><big>)</big><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>
1665 <dd><p>Add a comment</p>
1666 <table class="docutils field-list" frame="void" rules="none">
1667 <col class="field-name" />
1668 <col class="field-body" />
1669 <tbody valign="top">
1670 <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>
1671 </tr>
1672 </tbody>
1673 </table>
1674 </dd></dl>
1675
1676 <dl class="method">
1677 <dt id="src.fileEnviron.ContextFileEnviron.add_warning">
1678 <tt class="descname">add_warning</tt><big>(</big><em>warning</em><big>)</big><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>
1679 <dd><p>Add a warning</p>
1680 <table class="docutils field-list" frame="void" rules="none">
1681 <col class="field-name" />
1682 <col class="field-body" />
1683 <tbody valign="top">
1684 <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>
1685 </tr>
1686 </tbody>
1687 </table>
1688 </dd></dl>
1689
1690 <dl class="method">
1691 <dt id="src.fileEnviron.ContextFileEnviron.append_value">
1692 <tt class="descname">append_value</tt><big>(</big><em>key</em>, <em>value</em>, <em>sep=':'</em><big>)</big><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>
1693 <dd><p>append value to key using sep</p>
1694 <table class="docutils field-list" frame="void" rules="none">
1695 <col class="field-name" />
1696 <col class="field-body" />
1697 <tbody valign="top">
1698 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1699 <li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
1700 <li><strong>str</strong> -- the value to append to key</li>
1701 <li><strong>str</strong> -- the separator string</li>
1702 </ul>
1703 </td>
1704 </tr>
1705 </tbody>
1706 </table>
1707 </dd></dl>
1708
1709 <dl class="method">
1710 <dt id="src.fileEnviron.ContextFileEnviron.command_value">
1711 <tt class="descname">command_value</tt><big>(</big><em>key</em>, <em>command</em><big>)</big><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>
1712 <dd><p>Get the value given by the system command &quot;command&quot;
1713 and put it in the environment variable key.
1714 Has to be overwritten in the derived classes
1715 This can be seen as a virtual method</p>
1716 <table class="docutils field-list" frame="void" rules="none">
1717 <col class="field-name" />
1718 <col class="field-body" />
1719 <tbody valign="top">
1720 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1721 <li><strong>str</strong> (<em>command</em>) -- the environment variable</li>
1722 <li><strong>str</strong> -- the command to execute</li>
1723 </ul>
1724 </td>
1725 </tr>
1726 </tbody>
1727 </table>
1728 </dd></dl>
1729
1730 <dl class="method">
1731 <dt id="src.fileEnviron.ContextFileEnviron.finish">
1732 <tt class="descname">finish</tt><big>(</big><em>required=True</em><big>)</big><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>
1733 <dd><p>Add a final instruction in the out file (in case of file generation)</p>
1734 <table class="docutils field-list" frame="void" rules="none">
1735 <col class="field-name" />
1736 <col class="field-body" />
1737 <tbody valign="top">
1738 <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>
1739 </tr>
1740 </tbody>
1741 </table>
1742 </dd></dl>
1743
1744 <dl class="method">
1745 <dt id="src.fileEnviron.ContextFileEnviron.get">
1746 <tt class="descname">get</tt><big>(</big><em>key</em><big>)</big><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>
1747 <dd><p>Get the value of the environment variable &quot;key&quot;</p>
1748 <table class="docutils field-list" frame="void" rules="none">
1749 <col class="field-name" />
1750 <col class="field-body" />
1751 <tbody valign="top">
1752 <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>
1753 </tr>
1754 </tbody>
1755 </table>
1756 </dd></dl>
1757
1758 <dl class="method">
1759 <dt id="src.fileEnviron.ContextFileEnviron.prepend_value">
1760 <tt class="descname">prepend_value</tt><big>(</big><em>key</em>, <em>value</em>, <em>sep=':'</em><big>)</big><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>
1761 <dd><p>prepend value to key using sep</p>
1762 <table class="docutils field-list" frame="void" rules="none">
1763 <col class="field-name" />
1764 <col class="field-body" />
1765 <tbody valign="top">
1766 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1767 <li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
1768 <li><strong>str</strong> -- the value to prepend to key</li>
1769 <li><strong>str</strong> -- the separator string</li>
1770 </ul>
1771 </td>
1772 </tr>
1773 </tbody>
1774 </table>
1775 </dd></dl>
1776
1777 <dl class="method">
1778 <dt id="src.fileEnviron.ContextFileEnviron.set">
1779 <tt class="descname">set</tt><big>(</big><em>key</em>, <em>value</em><big>)</big><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>
1780 <dd><p>Set the environment variable &quot;key&quot; to value &quot;value&quot;</p>
1781 <table class="docutils field-list" frame="void" rules="none">
1782 <col class="field-name" />
1783 <col class="field-body" />
1784 <tbody valign="top">
1785 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1786 <li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
1787 <li><strong>str</strong> -- the value</li>
1788 </ul>
1789 </td>
1790 </tr>
1791 </tbody>
1792 </table>
1793 </dd></dl>
1794
1795 </dd></dl>
1796
1797 <dl class="class">
1798 <dt id="src.fileEnviron.FileEnviron">
1799 <em class="property">class </em><tt class="descclassname">src.fileEnviron.</tt><tt class="descname">FileEnviron</tt><big>(</big><em>output</em>, <em>environ=None</em><big>)</big><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>
1800 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
1801 <p>Base class for shell environment</p>
1802 <dl class="method">
1803 <dt id="src.fileEnviron.FileEnviron.add_comment">
1804 <tt class="descname">add_comment</tt><big>(</big><em>comment</em><big>)</big><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>
1805 <dd><p>Add a comment in the shell file</p>
1806 <table class="docutils field-list" frame="void" rules="none">
1807 <col class="field-name" />
1808 <col class="field-body" />
1809 <tbody valign="top">
1810 <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>
1811 </tr>
1812 </tbody>
1813 </table>
1814 </dd></dl>
1815
1816 <dl class="method">
1817 <dt id="src.fileEnviron.FileEnviron.add_echo">
1818 <tt class="descname">add_echo</tt><big>(</big><em>text</em><big>)</big><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>
1819 <dd><p>Add a &quot;echo&quot; in the shell file</p>
1820 <table class="docutils field-list" frame="void" rules="none">
1821 <col class="field-name" />
1822 <col class="field-body" />
1823 <tbody valign="top">
1824 <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>
1825 </tr>
1826 </tbody>
1827 </table>
1828 </dd></dl>
1829
1830 <dl class="method">
1831 <dt id="src.fileEnviron.FileEnviron.add_line">
1832 <tt class="descname">add_line</tt><big>(</big><em>number</em><big>)</big><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>
1833 <dd><p>Add some empty lines in the shell file</p>
1834 <table class="docutils field-list" frame="void" rules="none">
1835 <col class="field-name" />
1836 <col class="field-body" />
1837 <tbody valign="top">
1838 <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>
1839 </tr>
1840 </tbody>
1841 </table>
1842 </dd></dl>
1843
1844 <dl class="method">
1845 <dt id="src.fileEnviron.FileEnviron.add_warning">
1846 <tt class="descname">add_warning</tt><big>(</big><em>warning</em><big>)</big><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>
1847 <dd><p>Add a warning &quot;echo&quot; in the shell file</p>
1848 <table class="docutils field-list" frame="void" rules="none">
1849 <col class="field-name" />
1850 <col class="field-body" />
1851 <tbody valign="top">
1852 <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>
1853 </tr>
1854 </tbody>
1855 </table>
1856 </dd></dl>
1857
1858 <dl class="method">
1859 <dt id="src.fileEnviron.FileEnviron.append">
1860 <tt class="descname">append</tt><big>(</big><em>key</em>, <em>value</em>, <em>sep=':'</em><big>)</big><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>
1861 <dd><p>Same as append_value but the value argument can be a list</p>
1862 <table class="docutils field-list" frame="void" rules="none">
1863 <col class="field-name" />
1864 <col class="field-body" />
1865 <tbody valign="top">
1866 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1867 <li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
1868 <li><strong>str or list</strong> (<em>value</em>) -- the value(s) to append to key</li>
1869 <li><strong>str</strong> -- the separator string</li>
1870 </ul>
1871 </td>
1872 </tr>
1873 </tbody>
1874 </table>
1875 </dd></dl>
1876
1877 <dl class="method">
1878 <dt id="src.fileEnviron.FileEnviron.append_value">
1879 <tt class="descname">append_value</tt><big>(</big><em>key</em>, <em>value</em>, <em>sep=':'</em><big>)</big><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>
1880 <dd><p>append value to key using sep</p>
1881 <table class="docutils field-list" frame="void" rules="none">
1882 <col class="field-name" />
1883 <col class="field-body" />
1884 <tbody valign="top">
1885 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1886 <li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
1887 <li><strong>str</strong> -- the value to append to key</li>
1888 <li><strong>str</strong> -- the separator string</li>
1889 </ul>
1890 </td>
1891 </tr>
1892 </tbody>
1893 </table>
1894 </dd></dl>
1895
1896 <dl class="method">
1897 <dt id="src.fileEnviron.FileEnviron.command_value">
1898 <tt class="descname">command_value</tt><big>(</big><em>key</em>, <em>command</em><big>)</big><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>
1899 <dd><p>Get the value given by the system command &quot;command&quot;
1900 and put it in the environment variable key.
1901 Has to be overwritten in the derived classes
1902 This can be seen as a virtual method</p>
1903 <table class="docutils field-list" frame="void" rules="none">
1904 <col class="field-name" />
1905 <col class="field-body" />
1906 <tbody valign="top">
1907 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1908 <li><strong>str</strong> (<em>command</em>) -- the environment variable</li>
1909 <li><strong>str</strong> -- the command to execute</li>
1910 </ul>
1911 </td>
1912 </tr>
1913 </tbody>
1914 </table>
1915 </dd></dl>
1916
1917 <dl class="method">
1918 <dt id="src.fileEnviron.FileEnviron.finish">
1919 <tt class="descname">finish</tt><big>(</big><em>required=True</em><big>)</big><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>
1920 <dd><p>Add a final instruction in the out file (in case of file generation)</p>
1921 <table class="docutils field-list" frame="void" rules="none">
1922 <col class="field-name" />
1923 <col class="field-body" />
1924 <tbody valign="top">
1925 <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>
1926 </tr>
1927 </tbody>
1928 </table>
1929 </dd></dl>
1930
1931 <dl class="method">
1932 <dt id="src.fileEnviron.FileEnviron.get">
1933 <tt class="descname">get</tt><big>(</big><em>key</em><big>)</big><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>
1934 <dd><p>Get the value of the environment variable &quot;key&quot;</p>
1935 <table class="docutils field-list" frame="void" rules="none">
1936 <col class="field-name" />
1937 <col class="field-body" />
1938 <tbody valign="top">
1939 <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>
1940 </tr>
1941 </tbody>
1942 </table>
1943 </dd></dl>
1944
1945 <dl class="method">
1946 <dt id="src.fileEnviron.FileEnviron.is_defined">
1947 <tt class="descname">is_defined</tt><big>(</big><em>key</em><big>)</big><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>
1948 <dd><p>Check if the key exists in the environment</p>
1949 <table class="docutils field-list" frame="void" rules="none">
1950 <col class="field-name" />
1951 <col class="field-body" />
1952 <tbody valign="top">
1953 <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>
1954 </tr>
1955 </tbody>
1956 </table>
1957 </dd></dl>
1958
1959 <dl class="method">
1960 <dt id="src.fileEnviron.FileEnviron.prepend">
1961 <tt class="descname">prepend</tt><big>(</big><em>key</em>, <em>value</em>, <em>sep=':'</em><big>)</big><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>
1962 <dd><p>Same as prepend_value but the value argument can be a list</p>
1963 <table class="docutils field-list" frame="void" rules="none">
1964 <col class="field-name" />
1965 <col class="field-body" />
1966 <tbody valign="top">
1967 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1968 <li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
1969 <li><strong>str or list</strong> (<em>value</em>) -- the value(s) to prepend to key</li>
1970 <li><strong>str</strong> -- the separator string</li>
1971 </ul>
1972 </td>
1973 </tr>
1974 </tbody>
1975 </table>
1976 </dd></dl>
1977
1978 <dl class="method">
1979 <dt id="src.fileEnviron.FileEnviron.prepend_value">
1980 <tt class="descname">prepend_value</tt><big>(</big><em>key</em>, <em>value</em>, <em>sep=':'</em><big>)</big><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>
1981 <dd><p>prepend value to key using sep</p>
1982 <table class="docutils field-list" frame="void" rules="none">
1983 <col class="field-name" />
1984 <col class="field-body" />
1985 <tbody valign="top">
1986 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1987 <li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
1988 <li><strong>str</strong> -- the value to prepend to key</li>
1989 <li><strong>str</strong> -- the separator string</li>
1990 </ul>
1991 </td>
1992 </tr>
1993 </tbody>
1994 </table>
1995 </dd></dl>
1996
1997 <dl class="method">
1998 <dt id="src.fileEnviron.FileEnviron.set">
1999 <tt class="descname">set</tt><big>(</big><em>key</em>, <em>value</em><big>)</big><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>
2000 <dd><p>Set the environment variable 'key' to value 'value'</p>
2001 <table class="docutils field-list" frame="void" rules="none">
2002 <col class="field-name" />
2003 <col class="field-body" />
2004 <tbody valign="top">
2005 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2006 <li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
2007 <li><strong>str</strong> -- the value</li>
2008 </ul>
2009 </td>
2010 </tr>
2011 </tbody>
2012 </table>
2013 </dd></dl>
2014
2015 </dd></dl>
2016
2017 <dl class="class">
2018 <dt id="src.fileEnviron.LauncherFileEnviron">
2019 <em class="property">class </em><tt class="descclassname">src.fileEnviron.</tt><tt class="descname">LauncherFileEnviron</tt><big>(</big><em>output</em>, <em>environ=None</em><big>)</big><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>
2020 <dd><p>Class to generate a launcher file script
2021 (in python syntax) SalomeContext API</p>
2022 <dl class="method">
2023 <dt id="src.fileEnviron.LauncherFileEnviron.add">
2024 <tt class="descname">add</tt><big>(</big><em>key</em>, <em>value</em><big>)</big><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>
2025 <dd><p>prepend value to key using sep</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 prepend</li>
2032 <li><strong>str</strong> -- the value to prepend to key</li>
2033 </ul>
2034 </td>
2035 </tr>
2036 </tbody>
2037 </table>
2038 </dd></dl>
2039
2040 <dl class="method">
2041 <dt id="src.fileEnviron.LauncherFileEnviron.add_comment">
2042 <tt class="descname">add_comment</tt><big>(</big><em>comment</em><big>)</big><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>
2043 <dd></dd></dl>
2044
2045 <dl class="method">
2046 <dt id="src.fileEnviron.LauncherFileEnviron.add_echo">
2047 <tt class="descname">add_echo</tt><big>(</big><em>text</em><big>)</big><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>
2048 <dd><p>Add a comment</p>
2049 <table class="docutils field-list" frame="void" rules="none">
2050 <col class="field-name" />
2051 <col class="field-body" />
2052 <tbody valign="top">
2053 <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>
2054 </tr>
2055 </tbody>
2056 </table>
2057 </dd></dl>
2058
2059 <dl class="method">
2060 <dt id="src.fileEnviron.LauncherFileEnviron.add_line">
2061 <tt class="descname">add_line</tt><big>(</big><em>number</em><big>)</big><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>
2062 <dd><p>Add some empty lines in the launcher file</p>
2063 <table class="docutils field-list" frame="void" rules="none">
2064 <col class="field-name" />
2065 <col class="field-body" />
2066 <tbody valign="top">
2067 <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>
2068 </tr>
2069 </tbody>
2070 </table>
2071 </dd></dl>
2072
2073 <dl class="method">
2074 <dt id="src.fileEnviron.LauncherFileEnviron.add_warning">
2075 <tt class="descname">add_warning</tt><big>(</big><em>warning</em><big>)</big><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>
2076 <dd><p>Add a warning</p>
2077 <table class="docutils field-list" frame="void" rules="none">
2078 <col class="field-name" />
2079 <col class="field-body" />
2080 <tbody valign="top">
2081 <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>
2082 </tr>
2083 </tbody>
2084 </table>
2085 </dd></dl>
2086
2087 <dl class="method">
2088 <dt id="src.fileEnviron.LauncherFileEnviron.append">
2089 <tt class="descname">append</tt><big>(</big><em>key</em>, <em>value</em>, <em>sep=':'</em><big>)</big><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>
2090 <dd><p>Same as append_value but the value argument can be a list</p>
2091 <table class="docutils field-list" frame="void" rules="none">
2092 <col class="field-name" />
2093 <col class="field-body" />
2094 <tbody valign="top">
2095 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2096 <li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
2097 <li><strong>str or list</strong> (<em>value</em>) -- the value(s) to append to key</li>
2098 <li><strong>str</strong> -- the separator string</li>
2099 </ul>
2100 </td>
2101 </tr>
2102 </tbody>
2103 </table>
2104 </dd></dl>
2105
2106 <dl class="method">
2107 <dt id="src.fileEnviron.LauncherFileEnviron.append_value">
2108 <tt class="descname">append_value</tt><big>(</big><em>key</em>, <em>value</em>, <em>sep=':'</em><big>)</big><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>
2109 <dd><p>append value to key using sep</p>
2110 <table class="docutils field-list" frame="void" rules="none">
2111 <col class="field-name" />
2112 <col class="field-body" />
2113 <tbody valign="top">
2114 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2115 <li><strong>str</strong> (<em>sep</em>) -- the environment variable to append</li>
2116 <li><strong>str</strong> -- the value to append to key</li>
2117 <li><strong>str</strong> -- the separator string</li>
2118 </ul>
2119 </td>
2120 </tr>
2121 </tbody>
2122 </table>
2123 </dd></dl>
2124
2125 <dl class="method">
2126 <dt id="src.fileEnviron.LauncherFileEnviron.change_to_launcher">
2127 <tt class="descname">change_to_launcher</tt><big>(</big><em>value</em><big>)</big><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>
2128 <dd></dd></dl>
2129
2130 <dl class="method">
2131 <dt id="src.fileEnviron.LauncherFileEnviron.command_value">
2132 <tt class="descname">command_value</tt><big>(</big><em>key</em>, <em>command</em><big>)</big><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>
2133 <dd><p>Get the value given by the system command &quot;command&quot;
2134 and put it in the environment variable key.</p>
2135 <table class="docutils field-list" frame="void" rules="none">
2136 <col class="field-name" />
2137 <col class="field-body" />
2138 <tbody valign="top">
2139 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2140 <li><strong>str</strong> (<em>command</em>) -- the environment variable</li>
2141 <li><strong>str</strong> -- the command to execute</li>
2142 </ul>
2143 </td>
2144 </tr>
2145 </tbody>
2146 </table>
2147 </dd></dl>
2148
2149 <dl class="method">
2150 <dt id="src.fileEnviron.LauncherFileEnviron.finish">
2151 <tt class="descname">finish</tt><big>(</big><em>required=True</em><big>)</big><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>
2152 <dd><p>Add a final instruction in the out file (in case of file generation)
2153 In the particular launcher case, do nothing</p>
2154 <table class="docutils field-list" frame="void" rules="none">
2155 <col class="field-name" />
2156 <col class="field-body" />
2157 <tbody valign="top">
2158 <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>
2159 </tr>
2160 </tbody>
2161 </table>
2162 </dd></dl>
2163
2164 <dl class="method">
2165 <dt id="src.fileEnviron.LauncherFileEnviron.get">
2166 <tt class="descname">get</tt><big>(</big><em>key</em><big>)</big><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>
2167 <dd><p>Get the value of the environment variable &quot;key&quot;</p>
2168 <table class="docutils field-list" frame="void" rules="none">
2169 <col class="field-name" />
2170 <col class="field-body" />
2171 <tbody valign="top">
2172 <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>
2173 </tr>
2174 </tbody>
2175 </table>
2176 </dd></dl>
2177
2178 <dl class="method">
2179 <dt id="src.fileEnviron.LauncherFileEnviron.is_defined">
2180 <tt class="descname">is_defined</tt><big>(</big><em>key</em><big>)</big><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>
2181 <dd><p>Check if the key exists in the environment</p>
2182 <table class="docutils field-list" frame="void" rules="none">
2183 <col class="field-name" />
2184 <col class="field-body" />
2185 <tbody valign="top">
2186 <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>
2187 </tr>
2188 </tbody>
2189 </table>
2190 </dd></dl>
2191
2192 <dl class="method">
2193 <dt id="src.fileEnviron.LauncherFileEnviron.prepend">
2194 <tt class="descname">prepend</tt><big>(</big><em>key</em>, <em>value</em>, <em>sep=':'</em><big>)</big><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>
2195 <dd><p>Same as prepend_value but the value argument can be a list</p>
2196 <table class="docutils field-list" frame="void" rules="none">
2197 <col class="field-name" />
2198 <col class="field-body" />
2199 <tbody valign="top">
2200 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2201 <li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
2202 <li><strong>str or list</strong> (<em>value</em>) -- the value(s) to prepend to key</li>
2203 <li><strong>str</strong> -- the separator string</li>
2204 </ul>
2205 </td>
2206 </tr>
2207 </tbody>
2208 </table>
2209 </dd></dl>
2210
2211 <dl class="method">
2212 <dt id="src.fileEnviron.LauncherFileEnviron.prepend_value">
2213 <tt class="descname">prepend_value</tt><big>(</big><em>key</em>, <em>value</em>, <em>sep=':'</em><big>)</big><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>
2214 <dd><p>prepend value to key using sep</p>
2215 <table class="docutils field-list" frame="void" rules="none">
2216 <col class="field-name" />
2217 <col class="field-body" />
2218 <tbody valign="top">
2219 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2220 <li><strong>str</strong> (<em>sep</em>) -- the environment variable to prepend</li>
2221 <li><strong>str</strong> -- the value to prepend to key</li>
2222 <li><strong>str</strong> -- the separator string</li>
2223 </ul>
2224 </td>
2225 </tr>
2226 </tbody>
2227 </table>
2228 </dd></dl>
2229
2230 <dl class="method">
2231 <dt id="src.fileEnviron.LauncherFileEnviron.set">
2232 <tt class="descname">set</tt><big>(</big><em>key</em>, <em>value</em><big>)</big><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>
2233 <dd><p>Set the environment variable &quot;key&quot; to value &quot;value&quot;</p>
2234 <table class="docutils field-list" frame="void" rules="none">
2235 <col class="field-name" />
2236 <col class="field-body" />
2237 <tbody valign="top">
2238 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2239 <li><strong>str</strong> (<em>value</em>) -- the environment variable to set</li>
2240 <li><strong>str</strong> -- the value</li>
2241 </ul>
2242 </td>
2243 </tr>
2244 </tbody>
2245 </table>
2246 </dd></dl>
2247
2248 </dd></dl>
2249
2250 <dl class="class">
2251 <dt id="src.fileEnviron.ScreenEnviron">
2252 <em class="property">class </em><tt class="descclassname">src.fileEnviron.</tt><tt class="descname">ScreenEnviron</tt><big>(</big><em>output</em>, <em>environ=None</em><big>)</big><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>
2253 <dd><p>Bases: <a class="reference internal" href="#src.fileEnviron.FileEnviron" title="src.fileEnviron.FileEnviron"><tt class="xref py py-class docutils literal"><span class="pre">src.fileEnviron.FileEnviron</span></tt></a></p>
2254 <dl class="method">
2255 <dt id="src.fileEnviron.ScreenEnviron.add_comment">
2256 <tt class="descname">add_comment</tt><big>(</big><em>comment</em><big>)</big><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>
2257 <dd></dd></dl>
2258
2259 <dl class="method">
2260 <dt id="src.fileEnviron.ScreenEnviron.add_echo">
2261 <tt class="descname">add_echo</tt><big>(</big><em>text</em><big>)</big><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>
2262 <dd></dd></dl>
2263
2264 <dl class="method">
2265 <dt id="src.fileEnviron.ScreenEnviron.add_line">
2266 <tt class="descname">add_line</tt><big>(</big><em>number</em><big>)</big><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>
2267 <dd></dd></dl>
2268
2269 <dl class="method">
2270 <dt id="src.fileEnviron.ScreenEnviron.add_warning">
2271 <tt class="descname">add_warning</tt><big>(</big><em>warning</em><big>)</big><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>
2272 <dd></dd></dl>
2273
2274 <dl class="method">
2275 <dt id="src.fileEnviron.ScreenEnviron.append">
2276 <tt class="descname">append</tt><big>(</big><em>name</em>, <em>value</em>, <em>sep=':'</em><big>)</big><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>
2277 <dd></dd></dl>
2278
2279 <dl class="method">
2280 <dt id="src.fileEnviron.ScreenEnviron.command_value">
2281 <tt class="descname">command_value</tt><big>(</big><em>key</em>, <em>command</em><big>)</big><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>
2282 <dd></dd></dl>
2283
2284 <dl class="method">
2285 <dt id="src.fileEnviron.ScreenEnviron.get">
2286 <tt class="descname">get</tt><big>(</big><em>name</em><big>)</big><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>
2287 <dd></dd></dl>
2288
2289 <dl class="method">
2290 <dt id="src.fileEnviron.ScreenEnviron.is_defined">
2291 <tt class="descname">is_defined</tt><big>(</big><em>name</em><big>)</big><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>
2292 <dd></dd></dl>
2293
2294 <dl class="method">
2295 <dt id="src.fileEnviron.ScreenEnviron.prepend">
2296 <tt class="descname">prepend</tt><big>(</big><em>name</em>, <em>value</em>, <em>sep=':'</em><big>)</big><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>
2297 <dd></dd></dl>
2298
2299 <dl class="method">
2300 <dt id="src.fileEnviron.ScreenEnviron.run_env_script">
2301 <tt class="descname">run_env_script</tt><big>(</big><em>module</em>, <em>script</em><big>)</big><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>
2302 <dd></dd></dl>
2303
2304 <dl class="method">
2305 <dt id="src.fileEnviron.ScreenEnviron.set">
2306 <tt class="descname">set</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><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>
2307 <dd></dd></dl>
2308
2309 <dl class="method">
2310 <dt id="src.fileEnviron.ScreenEnviron.write">
2311 <tt class="descname">write</tt><big>(</big><em>command</em>, <em>name</em>, <em>value</em>, <em>sign='='</em><big>)</big><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>
2312 <dd></dd></dl>
2313
2314 </dd></dl>
2315
2316 <dl class="function">
2317 <dt id="src.fileEnviron.get_file_environ">
2318 <tt class="descclassname">src.fileEnviron.</tt><tt class="descname">get_file_environ</tt><big>(</big><em>output</em>, <em>shell</em>, <em>environ=None</em><big>)</big><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>
2319 <dd><p>Instantiate correct FileEnvironment sub-class.</p>
2320 <table class="docutils field-list" frame="void" rules="none">
2321 <col class="field-name" />
2322 <col class="field-body" />
2323 <tbody valign="top">
2324 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2325 <li><strong>file</strong> (<em>output</em>) -- the output file stream.</li>
2326 <li><strong>str</strong> (<em>shell</em>) -- the type of shell syntax to use.</li>
2327 <li><strong>dict</strong> (<em>environ</em>) -- a potential additional environment.</li>
2328 </ul>
2329 </td>
2330 </tr>
2331 </tbody>
2332 </table>
2333 </dd></dl>
2334
2335 <dl class="function">
2336 <dt id="src.fileEnviron.special_path_separator">
2337 <tt class="descclassname">src.fileEnviron.</tt><tt class="descname">special_path_separator</tt><big>(</big><em>name</em><big>)</big><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>
2338 <dd><p>TCLLIBPATH, TKLIBPATH, PV_PLUGIN_PATH environments variables need
2339 some exotic path separator.
2340 This function gives the separator regarding the name of the variable
2341 to append or prepend.</p>
2342 <table class="docutils field-list" frame="void" rules="none">
2343 <col class="field-name" />
2344 <col class="field-body" />
2345 <tbody valign="top">
2346 <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>
2347 </tr>
2348 </tbody>
2349 </table>
2350 </dd></dl>
2351
2352 </div>
2353 <div class="section" id="module-src.fork">
2354 <span id="fork-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">fork</span></tt> Module<a class="headerlink" href="#module-src.fork" title="Permalink to this headline">¶</a></h2>
2355 <dl class="function">
2356 <dt id="src.fork.batch">
2357 <tt class="descclassname">src.fork.</tt><tt class="descname">batch</tt><big>(</big><em>cmd</em>, <em>logger</em>, <em>cwd</em>, <em>args=</em><span class="optional">[</span><span class="optional">]</span>, <em>log=None</em>, <em>delai=20</em>, <em>sommeil=1</em><big>)</big><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>
2358 <dd></dd></dl>
2359
2360 <dl class="function">
2361 <dt id="src.fork.batch_salome">
2362 <tt class="descclassname">src.fork.</tt><tt class="descname">batch_salome</tt><big>(</big><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><big>)</big><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>
2363 <dd></dd></dl>
2364
2365 <dl class="function">
2366 <dt id="src.fork.launch_command">
2367 <tt class="descclassname">src.fork.</tt><tt class="descname">launch_command</tt><big>(</big><em>cmd</em>, <em>logger</em>, <em>cwd</em>, <em>args=</em><span class="optional">[</span><span class="optional">]</span>, <em>log=None</em><big>)</big><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>
2368 <dd></dd></dl>
2369
2370 <dl class="function">
2371 <dt id="src.fork.show_progress">
2372 <tt class="descclassname">src.fork.</tt><tt class="descname">show_progress</tt><big>(</big><em>logger</em>, <em>top</em>, <em>delai</em>, <em>ss=''</em><big>)</big><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>
2373 <dd><p>shortcut function to display the progression</p>
2374 <table class="docutils field-list" frame="void" rules="none">
2375 <col class="field-name" />
2376 <col class="field-body" />
2377 <tbody valign="top">
2378 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2379 <li><strong>Logger</strong> (<em>logger</em>) -- The logging instance</li>
2380 <li><strong>int</strong> (<em>delai</em>) -- the number to display</li>
2381 <li><strong>int</strong> -- the number max</li>
2382 <li><strong>str</strong> (<em>ss</em>) -- the string to display</li>
2383 </ul>
2384 </td>
2385 </tr>
2386 </tbody>
2387 </table>
2388 </dd></dl>
2389
2390 <dl class="function">
2391 <dt id="src.fork.write_back">
2392 <tt class="descclassname">src.fork.</tt><tt class="descname">write_back</tt><big>(</big><em>logger</em>, <em>message</em>, <em>level</em><big>)</big><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>
2393 <dd><p>shortcut function to write at the begin of the line</p>
2394 <table class="docutils field-list" frame="void" rules="none">
2395 <col class="field-name" />
2396 <col class="field-body" />
2397 <tbody valign="top">
2398 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2399 <li><strong>Logger</strong> (<em>logger</em>) -- The logging instance</li>
2400 <li><strong>str</strong> (<em>message</em>) -- the text to display</li>
2401 <li><strong>int</strong> (<em>level</em>) -- the level of verbosity</li>
2402 </ul>
2403 </td>
2404 </tr>
2405 </tbody>
2406 </table>
2407 </dd></dl>
2408
2409 </div>
2410 <div class="section" id="module-src.logger">
2411 <span id="logger-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">logger</span></tt> Module<a class="headerlink" href="#module-src.logger" title="Permalink to this headline">¶</a></h2>
2412 <p>Implements the classes and method relative to the logging</p>
2413 <dl class="class">
2414 <dt id="src.logger.Logger">
2415 <em class="property">class </em><tt class="descclassname">src.logger.</tt><tt class="descname">Logger</tt><big>(</big><em>config</em>, <em>silent_sysstd=False</em>, <em>all_in_terminal=False</em>, <em>micro_command=False</em><big>)</big><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>
2416 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
2417 <p>Class to handle log mechanism.</p>
2418 <dl class="method">
2419 <dt id="src.logger.Logger.add_link">
2420 <tt class="descname">add_link</tt><big>(</big><em>log_file_name</em>, <em>command_name</em>, <em>command_res</em>, <em>full_launched_command</em><big>)</big><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>
2421 <dd><p>Add a link to another log file.</p>
2422 <table class="docutils field-list" frame="void" rules="none">
2423 <col class="field-name" />
2424 <col class="field-body" />
2425 <tbody valign="top">
2426 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
2427 <li><strong>str</strong> (<em>command_res</em>) -- The file name of the link.</li>
2428 <li><strong>str</strong> -- The name of the command linked.</li>
2429 <li><strong>str</strong> -- The result of the command linked. &quot;0&quot; or &quot;1&quot;</li>
2430 </ul>
2431 </td>
2432 </tr>
2433 <tr class="field-even field"><th class="field-name" colspan="2">Parma full_launched_command str:</th></tr>
2434 <tr class="field-even field"><td>&nbsp;</td><td class="field-body"><p class="first last">The full lanch command
2435 (&quot;sat command ...&quot;)</p>
2436 </td>
2437 </tr>
2438 </tbody>
2439 </table>
2440 </dd></dl>
2441
2442 <dl class="method">
2443 <dt id="src.logger.Logger.end_write">
2444 <tt class="descname">end_write</tt><big>(</big><em>attribute</em><big>)</big><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>
2445 <dd><p>Called just after command end: Put all fields
2446 corresponding to the command end context (time).
2447 Write the log xml file on the hard drive.
2448 And display the command to launch to get the log</p>
2449 <table class="docutils field-list" frame="void" rules="none">
2450 <col class="field-name" />
2451 <col class="field-body" />
2452 <tbody valign="top">
2453 <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 &quot;Site&quot;.</td>
2454 </tr>
2455 </tbody>
2456 </table>
2457 </dd></dl>
2458
2459 <dl class="method">
2460 <dt id="src.logger.Logger.error">
2461 <tt class="descname">error</tt><big>(</big><em>message</em><big>)</big><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>
2462 <dd><p>Print an error.</p>
2463 <table class="docutils field-list" frame="void" rules="none">
2464 <col class="field-name" />
2465 <col class="field-body" />
2466 <tbody valign="top">
2467 <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>
2468 </tr>
2469 </tbody>
2470 </table>
2471 </dd></dl>
2472
2473 <dl class="method">
2474 <dt id="src.logger.Logger.flush">
2475 <tt class="descname">flush</tt><big>(</big><big>)</big><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>
2476 <dd><p>Flush terminal</p>
2477 </dd></dl>
2478
2479 <dl class="method">
2480 <dt id="src.logger.Logger.put_initial_xml_fields">
2481 <tt class="descname">put_initial_xml_fields</tt><big>(</big><big>)</big><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>
2482 <dd><p>Called at class initialization: Put all fields
2483 corresponding to the command context (user, time, ...)</p>
2484 </dd></dl>
2485
2486 <dl class="method">
2487 <dt id="src.logger.Logger.write">
2488 <tt class="descname">write</tt><big>(</big><em>message</em>, <em>level=None</em>, <em>screenOnly=False</em><big>)</big><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>
2489 <dd><p>function used in the commands
2490 to print in the terminal and the log file.</p>
2491 <table class="docutils field-list" frame="void" rules="none">
2492 <col class="field-name" />
2493 <col class="field-body" />
2494 <tbody valign="top">
2495 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2496 <li><strong>str</strong> (<em>message</em>) -- The message to print.</li>
2497 <li><strong>int</strong> (<em>level</em>) -- The output level corresponding
2498 to the message 0 &lt; level &lt; 6.</li>
2499 <li><strong>boolean</strong> (<em>screenOnly</em>) -- if True, do not write in log file.</li>
2500 </ul>
2501 </td>
2502 </tr>
2503 </tbody>
2504 </table>
2505 </dd></dl>
2506
2507 </dd></dl>
2508
2509 <dl class="function">
2510 <dt id="src.logger.date_to_datetime">
2511 <tt class="descclassname">src.logger.</tt><tt class="descname">date_to_datetime</tt><big>(</big><em>date</em><big>)</big><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>
2512 <dd><p>From a string date in format YYYYMMDD_HHMMSS
2513 returns list year, mon, day, hour, minutes, seconds</p>
2514 <table class="docutils field-list" frame="void" rules="none">
2515 <col class="field-name" />
2516 <col class="field-body" />
2517 <tbody valign="top">
2518 <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>
2519 </tr>
2520 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the same date and time in separate variables.</td>
2521 </tr>
2522 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">(str,str,str,str,str,str)</td>
2523 </tr>
2524 </tbody>
2525 </table>
2526 </dd></dl>
2527
2528 <dl class="function">
2529 <dt id="src.logger.list_log_file">
2530 <tt class="descclassname">src.logger.</tt><tt class="descname">list_log_file</tt><big>(</big><em>dirPath</em>, <em>expression</em><big>)</big><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>
2531 <dd><p>Find all files corresponding to expression in dirPath</p>
2532 <table class="docutils field-list" frame="void" rules="none">
2533 <col class="field-name" />
2534 <col class="field-body" />
2535 <tbody valign="top">
2536 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
2537 <li><strong>str</strong> (<em>expression</em>) -- the directory where to search the files</li>
2538 <li><strong>str</strong> -- the regular expression of files to find</li>
2539 </ul>
2540 </td>
2541 </tr>
2542 <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>
2543 </td>
2544 </tr>
2545 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list</p>
2546 </td>
2547 </tr>
2548 </tbody>
2549 </table>
2550 </dd></dl>
2551
2552 <dl class="function">
2553 <dt id="src.logger.show_command_log">
2554 <tt class="descclassname">src.logger.</tt><tt class="descname">show_command_log</tt><big>(</big><em>logFilePath</em>, <em>cmd</em>, <em>application</em>, <em>notShownCommands</em><big>)</big><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>
2555 <dd><p>Used in updateHatXml.
2556 Determine if the log xml file logFilePath
2557 has to be shown or not in the hat log.</p>
2558 <table class="docutils field-list" frame="void" rules="none">
2559 <col class="field-name" />
2560 <col class="field-body" />
2561 <tbody valign="top">
2562 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
2563 <li><strong>str</strong> (<em>application</em>) -- the path to the command xml log file</li>
2564 <li><strong>str</strong> -- the command of the log file</li>
2565 <li><strong>str</strong> -- the application passed as parameter
2566 to the salomeTools command</li>
2567 <li><strong>list</strong> (<em>notShownCommands</em>) -- the list of commands
2568 that are not shown by default</li>
2569 </ul>
2570 </td>
2571 </tr>
2572 <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
2573 in the log file corresponds to application</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">boolean</p>
2577 </td>
2578 </tr>
2579 </tbody>
2580 </table>
2581 </dd></dl>
2582
2583 <dl class="function">
2584 <dt id="src.logger.timedelta_total_seconds">
2585 <tt class="descclassname">src.logger.</tt><tt class="descname">timedelta_total_seconds</tt><big>(</big><em>timedelta</em><big>)</big><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>
2586 <dd><p>Replace total_seconds from datetime module
2587 in order to be compatible with old python versions</p>
2588 <table class="docutils field-list" frame="void" rules="none">
2589 <col class="field-name" />
2590 <col class="field-body" />
2591 <tbody valign="top">
2592 <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>
2593 </tr>
2594 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The number of seconds corresponding to timedelta.</td>
2595 </tr>
2596 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">float</td>
2597 </tr>
2598 </tbody>
2599 </table>
2600 </dd></dl>
2601
2602 <dl class="function">
2603 <dt id="src.logger.update_hat_xml">
2604 <tt class="descclassname">src.logger.</tt><tt class="descname">update_hat_xml</tt><big>(</big><em>logDir</em>, <em>application=None</em>, <em>notShownCommands=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><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>
2605 <dd><p>Create the xml file in logDir that contain all the xml file
2606 and have a name like YYYYMMDD_HHMMSS_namecmd.xml</p>
2607 <table class="docutils field-list" frame="void" rules="none">
2608 <col class="field-name" />
2609 <col class="field-body" />
2610 <tbody valign="top">
2611 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2612 <li><strong>str</strong> (<em>application</em>) -- the directory to parse</li>
2613 <li><strong>str</strong> -- the name of the application if there is any</li>
2614 </ul>
2615 </td>
2616 </tr>
2617 </tbody>
2618 </table>
2619 </dd></dl>
2620
2621 </div>
2622 <div class="section" id="module-src.options">
2623 <span id="options-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">options</span></tt> Module<a class="headerlink" href="#module-src.options" title="Permalink to this headline">¶</a></h2>
2624 <p>The Options class that manages the access to all options passed as
2625 parameters in salomeTools command lines</p>
2626 <dl class="class">
2627 <dt id="src.options.OptResult">
2628 <em class="property">class </em><tt class="descclassname">src.options.</tt><tt class="descname">OptResult</tt><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>
2629 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
2630 <p>An instance of this class will be the object manipulated
2631 in code of all salomeTools commands
2632 The aim of this class is to have an elegant syntax
2633 to manipulate the options.
2634 ex:
2635 print(options.level)
2636 5</p>
2637 </dd></dl>
2638
2639 <dl class="class">
2640 <dt id="src.options.Options">
2641 <em class="property">class </em><tt class="descclassname">src.options.</tt><tt class="descname">Options</tt><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>
2642 <dd><p>Class to manage all salomeTools options</p>
2643 <dl class="method">
2644 <dt id="src.options.Options.add_option">
2645 <tt class="descname">add_option</tt><big>(</big><em>shortName</em>, <em>longName</em>, <em>optionType</em>, <em>destName</em>, <em>helpString=''</em>, <em>default=None</em><big>)</big><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>
2646 <dd><p>Method to add an option to a command. It gets all attributes
2647 of an option and append it in the options field</p>
2648 <table class="docutils field-list" frame="void" rules="none">
2649 <col class="field-name" />
2650 <col class="field-body" />
2651 <tbody valign="top">
2652 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
2653 <li><strong>str</strong> (<em>helpString</em>) -- The short name of the option
2654 (ex &quot;l&quot; for level option).</li>
2655 <li><strong>str</strong> -- The long name of the option
2656 (ex &quot;level&quot; for level option).</li>
2657 <li><strong>str</strong> -- The type of the option (ex &quot;int&quot;).</li>
2658 <li><strong>str</strong> -- The name that will be used in the code.</li>
2659 <li><strong>str</strong> -- The text to display
2660 when user ask for help on a command.</li>
2661 </ul>
2662 </td>
2663 </tr>
2664 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Nothing.</p>
2665 </td>
2666 </tr>
2667 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">NA</p>
2668 </td>
2669 </tr>
2670 </tbody>
2671 </table>
2672 </dd></dl>
2673
2674 <dl class="method">
2675 <dt id="src.options.Options.parse_args">
2676 <tt class="descname">parse_args</tt><big>(</big><em>argList=None</em><big>)</big><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>
2677 <dd><p>Method that instantiates the class OptResult
2678 that gives access to all options in the code</p>
2679 <table class="docutils field-list" frame="void" rules="none">
2680 <col class="field-name" />
2681 <col class="field-body" />
2682 <tbody valign="top">
2683 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>list</strong> (<em>argList</em>) -- the raw list of arguments that were passed</td>
2684 </tr>
2685 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">optResult, args : optResult is the option instance
2686 to manipulate in the code. args
2687 is the full raw list of passed options</td>
2688 </tr>
2689 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">(class 'common.options.OptResult',list)</td>
2690 </tr>
2691 </tbody>
2692 </table>
2693 </dd></dl>
2694
2695 <dl class="method">
2696 <dt id="src.options.Options.print_help">
2697 <tt class="descname">print_help</tt><big>(</big><big>)</big><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>
2698 <dd><p>Method that display all options stored in self.options and there help</p>
2699 <table class="docutils field-list" frame="void" rules="none">
2700 <col class="field-name" />
2701 <col class="field-body" />
2702 <tbody valign="top">
2703 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Nothing.</td>
2704 </tr>
2705 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">NA</td>
2706 </tr>
2707 </tbody>
2708 </table>
2709 </dd></dl>
2710
2711 </dd></dl>
2712
2713 </div>
2714 <div class="section" id="module-src.printcolors">
2715 <span id="printcolors-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">printcolors</span></tt> Module<a class="headerlink" href="#module-src.printcolors" title="Permalink to this headline">¶</a></h2>
2716 <p>In this file is stored the mechanism that manage color prints in the terminal</p>
2717 <dl class="function">
2718 <dt id="src.printcolors.cleancolor">
2719 <tt class="descclassname">src.printcolors.</tt><tt class="descname">cleancolor</tt><big>(</big><em>message</em><big>)</big><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>
2720 <dd><p>remove color from a colored text.</p>
2721 <table class="docutils field-list" frame="void" rules="none">
2722 <col class="field-name" />
2723 <col class="field-body" />
2724 <tbody valign="top">
2725 <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>
2726 </tr>
2727 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The cleaned text.</td>
2728 </tr>
2729 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
2730 </tr>
2731 </tbody>
2732 </table>
2733 </dd></dl>
2734
2735 <dl class="function">
2736 <dt id="src.printcolors.print_color_map">
2737 <tt class="descclassname">src.printcolors.</tt><tt class="descname">print_color_map</tt><big>(</big><big>)</big><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>
2738 <dd><p>This method prints the color map</p>
2739 </dd></dl>
2740
2741 <dl class="function">
2742 <dt id="src.printcolors.print_color_range">
2743 <tt class="descclassname">src.printcolors.</tt><tt class="descname">print_color_range</tt><big>(</big><em>start</em>, <em>end</em><big>)</big><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>
2744 <dd><p>print possible range values for colors</p>
2745 <table class="docutils field-list" frame="void" rules="none">
2746 <col class="field-name" />
2747 <col class="field-body" />
2748 <tbody valign="top">
2749 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2750 <li><strong>int</strong> (<em>end</em>) -- The smaller value.</li>
2751 <li><strong>int</strong> -- The bigger value.</li>
2752 </ul>
2753 </td>
2754 </tr>
2755 </tbody>
2756 </table>
2757 </dd></dl>
2758
2759 <dl class="function">
2760 <dt id="src.printcolors.print_value">
2761 <tt class="descclassname">src.printcolors.</tt><tt class="descname">print_value</tt><big>(</big><em>logger</em>, <em>label</em>, <em>value</em>, <em>level=1</em>, <em>suffix=''</em><big>)</big><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>
2762 <dd><p>shortcut method to print a label and a value with the info color</p>
2763 <table class="docutils field-list" frame="void" rules="none">
2764 <col class="field-name" />
2765 <col class="field-body" />
2766 <tbody valign="top">
2767 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2768 <li><strong>class logger</strong> (<em>logger</em>) -- the logger instance.</li>
2769 <li><strong>int</strong> (<em>level</em>) -- the label to print.</li>
2770 <li><strong>str</strong> (<em>suffix</em>) -- the value to print.</li>
2771 <li><strong>int</strong> -- the level of verboseness.</li>
2772 <li><strong>str</strong> -- the suffix to add at the end.</li>
2773 </ul>
2774 </td>
2775 </tr>
2776 </tbody>
2777 </table>
2778 </dd></dl>
2779
2780 <dl class="function">
2781 <dt id="src.printcolors.printc">
2782 <tt class="descclassname">src.printcolors.</tt><tt class="descname">printc</tt><big>(</big><em>txt</em>, <em>code=''</em><big>)</big><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>
2783 <dd><p>print a text with colors</p>
2784 <table class="docutils field-list" frame="void" rules="none">
2785 <col class="field-name" />
2786 <col class="field-body" />
2787 <tbody valign="top">
2788 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
2789 <li><strong>str</strong> (<em>code</em>) -- The text to be printed.</li>
2790 <li><strong>str</strong> -- The color to use.</li>
2791 </ul>
2792 </td>
2793 </tr>
2794 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The colored text.</p>
2795 </td>
2796 </tr>
2797 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
2798 </td>
2799 </tr>
2800 </tbody>
2801 </table>
2802 </dd></dl>
2803
2804 <dl class="function">
2805 <dt id="src.printcolors.printcError">
2806 <tt class="descclassname">src.printcolors.</tt><tt class="descname">printcError</tt><big>(</big><em>txt</em><big>)</big><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>
2807 <dd><p>print a text error color</p>
2808 <table class="docutils field-list" frame="void" rules="none">
2809 <col class="field-name" />
2810 <col class="field-body" />
2811 <tbody valign="top">
2812 <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>
2813 </tr>
2814 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
2815 </tr>
2816 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
2817 </tr>
2818 </tbody>
2819 </table>
2820 </dd></dl>
2821
2822 <dl class="function">
2823 <dt id="src.printcolors.printcHeader">
2824 <tt class="descclassname">src.printcolors.</tt><tt class="descname">printcHeader</tt><big>(</big><em>txt</em><big>)</big><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>
2825 <dd><p>print a text header color</p>
2826 <table class="docutils field-list" frame="void" rules="none">
2827 <col class="field-name" />
2828 <col class="field-body" />
2829 <tbody valign="top">
2830 <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>
2831 </tr>
2832 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
2833 </tr>
2834 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
2835 </tr>
2836 </tbody>
2837 </table>
2838 </dd></dl>
2839
2840 <dl class="function">
2841 <dt id="src.printcolors.printcHighlight">
2842 <tt class="descclassname">src.printcolors.</tt><tt class="descname">printcHighlight</tt><big>(</big><em>txt</em><big>)</big><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>
2843 <dd><p>print a text highlight color</p>
2844 <table class="docutils field-list" frame="void" rules="none">
2845 <col class="field-name" />
2846 <col class="field-body" />
2847 <tbody valign="top">
2848 <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>
2849 </tr>
2850 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
2851 </tr>
2852 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
2853 </tr>
2854 </tbody>
2855 </table>
2856 </dd></dl>
2857
2858 <dl class="function">
2859 <dt id="src.printcolors.printcInfo">
2860 <tt class="descclassname">src.printcolors.</tt><tt class="descname">printcInfo</tt><big>(</big><em>txt</em><big>)</big><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>
2861 <dd><p>print a text info color</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"><strong>str</strong> (<em>txt</em>) -- The text to be printed.</td>
2867 </tr>
2868 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
2869 </tr>
2870 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
2871 </tr>
2872 </tbody>
2873 </table>
2874 </dd></dl>
2875
2876 <dl class="function">
2877 <dt id="src.printcolors.printcLabel">
2878 <tt class="descclassname">src.printcolors.</tt><tt class="descname">printcLabel</tt><big>(</big><em>txt</em><big>)</big><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>
2879 <dd><p>print a text label color</p>
2880 <table class="docutils field-list" frame="void" rules="none">
2881 <col class="field-name" />
2882 <col class="field-body" />
2883 <tbody valign="top">
2884 <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>
2885 </tr>
2886 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
2887 </tr>
2888 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
2889 </tr>
2890 </tbody>
2891 </table>
2892 </dd></dl>
2893
2894 <dl class="function">
2895 <dt id="src.printcolors.printcSuccess">
2896 <tt class="descclassname">src.printcolors.</tt><tt class="descname">printcSuccess</tt><big>(</big><em>txt</em><big>)</big><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>
2897 <dd><p>print a text success color</p>
2898 <table class="docutils field-list" frame="void" rules="none">
2899 <col class="field-name" />
2900 <col class="field-body" />
2901 <tbody valign="top">
2902 <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>
2903 </tr>
2904 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
2905 </tr>
2906 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
2907 </tr>
2908 </tbody>
2909 </table>
2910 </dd></dl>
2911
2912 <dl class="function">
2913 <dt id="src.printcolors.printcWarning">
2914 <tt class="descclassname">src.printcolors.</tt><tt class="descname">printcWarning</tt><big>(</big><em>txt</em><big>)</big><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>
2915 <dd><p>print a text warning color</p>
2916 <table class="docutils field-list" frame="void" rules="none">
2917 <col class="field-name" />
2918 <col class="field-body" />
2919 <tbody valign="top">
2920 <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>
2921 </tr>
2922 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The colored text.</td>
2923 </tr>
2924 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
2925 </tr>
2926 </tbody>
2927 </table>
2928 </dd></dl>
2929
2930 </div>
2931 <div class="section" id="module-src.product">
2932 <span id="product-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">product</span></tt> Module<a class="headerlink" href="#module-src.product" title="Permalink to this headline">¶</a></h2>
2933 <p>In this file are implemented the methods
2934 relative to the product notion of salomeTools</p>
2935 <dl class="function">
2936 <dt id="src.product.check_config_exists">
2937 <tt class="descclassname">src.product.</tt><tt class="descname">check_config_exists</tt><big>(</big><em>config</em>, <em>prod_dir</em>, <em>prod_info</em><big>)</big><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>
2938 <dd><p>Verify that the installation directory of a product in a base exists
2939 Check all the config-&lt;i&gt; directory and verify the sat-config.pyconf file
2940 that is in it</p>
2941 <table class="docutils field-list" frame="void" rules="none">
2942 <col class="field-name" />
2943 <col class="field-body" />
2944 <tbody valign="top">
2945 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
2946 <li><strong>Config</strong> (<em>product_info</em>) -- The global configuration</li>
2947 <li><strong>str</strong> (<em>prod_dir</em>) -- The product installation directory path
2948 (without config-&lt;i&gt;)</li>
2949 <li><strong>Config</strong> -- The configuration specific to
2950 the product</li>
2951 </ul>
2952 </td>
2953 </tr>
2954 <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
2955 and if it is found, the path of the found installation</p>
2956 </td>
2957 </tr>
2958 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">(boolean, str)</p>
2959 </td>
2960 </tr>
2961 </tbody>
2962 </table>
2963 </dd></dl>
2964
2965 <dl class="function">
2966 <dt id="src.product.check_installation">
2967 <tt class="descclassname">src.product.</tt><tt class="descname">check_installation</tt><big>(</big><em>product_info</em><big>)</big><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>
2968 <dd><p>Verify if a product is well installed. Checks install directory presence
2969 and some additional files if it is defined in the config</p>
2970 <table class="docutils field-list" frame="void" rules="none">
2971 <col class="field-name" />
2972 <col class="field-body" />
2973 <tbody valign="top">
2974 <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
2975 the product</td>
2976 </tr>
2977 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if it is well installed</td>
2978 </tr>
2979 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
2980 </tr>
2981 </tbody>
2982 </table>
2983 </dd></dl>
2984
2985 <dl class="function">
2986 <dt id="src.product.check_source">
2987 <tt class="descclassname">src.product.</tt><tt class="descname">check_source</tt><big>(</big><em>product_info</em><big>)</big><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>
2988 <dd><p>Verify if a sources of product is preset. Checks source directory presence</p>
2989 <table class="docutils field-list" frame="void" rules="none">
2990 <col class="field-name" />
2991 <col class="field-body" />
2992 <tbody valign="top">
2993 <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
2994 the product</td>
2995 </tr>
2996 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if it is well installed</td>
2997 </tr>
2998 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
2999 </tr>
3000 </tbody>
3001 </table>
3002 </dd></dl>
3003
3004 <dl class="function">
3005 <dt id="src.product.get_base_install_dir">
3006 <tt class="descclassname">src.product.</tt><tt class="descname">get_base_install_dir</tt><big>(</big><em>config</em>, <em>prod_info</em>, <em>version</em><big>)</big><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>
3007 <dd><p>Compute the installation directory of a product in base</p>
3008 <table class="docutils field-list" frame="void" rules="none">
3009 <col class="field-name" />
3010 <col class="field-body" />
3011 <tbody valign="top">
3012 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
3013 <li><strong>Config</strong> (<em>product_info</em>) -- The global configuration</li>
3014 <li><strong>Config</strong> -- The configuration specific to
3015 the product</li>
3016 <li><strong>str</strong> (<em>version</em>) -- The version of the product</li>
3017 </ul>
3018 </td>
3019 </tr>
3020 <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>
3021 </td>
3022 </tr>
3023 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
3024 </td>
3025 </tr>
3026 </tbody>
3027 </table>
3028 </dd></dl>
3029
3030 <dl class="function">
3031 <dt id="src.product.get_install_dir">
3032 <tt class="descclassname">src.product.</tt><tt class="descname">get_install_dir</tt><big>(</big><em>config</em>, <em>base</em>, <em>version</em>, <em>prod_info</em><big>)</big><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>
3033 <dd><p>Compute the installation directory of a given product</p>
3034 <table class="docutils field-list" frame="void" rules="none">
3035 <col class="field-name" />
3036 <col class="field-body" />
3037 <tbody valign="top">
3038 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
3039 <li><strong>Config</strong> (<em>product_info</em>) -- The global configuration</li>
3040 <li><strong>str</strong> (<em>version</em>) -- This corresponds to the value given by user in its
3041 application.pyconf for the specific product. If &quot;yes&quot;, the
3042 user wants the product to be in base. If &quot;no&quot;, he wants the
3043 product to be in the application workdir</li>
3044 <li><strong>str</strong> -- The version of the product</li>
3045 <li><strong>Config</strong> -- The configuration specific to
3046 the product</li>
3047 </ul>
3048 </td>
3049 </tr>
3050 <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>
3051 </td>
3052 </tr>
3053 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
3054 </td>
3055 </tr>
3056 </tbody>
3057 </table>
3058 </dd></dl>
3059
3060 <dl class="function">
3061 <dt id="src.product.get_product_components">
3062 <tt class="descclassname">src.product.</tt><tt class="descname">get_product_components</tt><big>(</big><em>product_info</em><big>)</big><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>
3063 <dd><p>Get the component list to generate with the product</p>
3064 <table class="docutils field-list" frame="void" rules="none">
3065 <col class="field-name" />
3066 <col class="field-body" />
3067 <tbody valign="top">
3068 <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
3069 the product</td>
3070 </tr>
3071 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The list of names of the components</td>
3072 </tr>
3073 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">List</td>
3074 </tr>
3075 </tbody>
3076 </table>
3077 </dd></dl>
3078
3079 <dl class="function">
3080 <dt id="src.product.get_product_config">
3081 <tt class="descclassname">src.product.</tt><tt class="descname">get_product_config</tt><big>(</big><em>config</em>, <em>product_name</em>, <em>with_install_dir=True</em><big>)</big><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>
3082 <dd><p>Get the specific configuration of a product from the global configuration</p>
3083 <table class="docutils field-list" frame="void" rules="none">
3084 <col class="field-name" />
3085 <col class="field-body" />
3086 <tbody valign="top">
3087 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
3088 <li><strong>Config</strong> (<em>config</em>) -- The global configuration</li>
3089 <li><strong>str</strong> (<em>product_name</em>) -- The name of the product</li>
3090 <li><strong>boolean</strong> (<em>with_install_dir</em>) -- If false, do not provide an install
3091 directory (at false only for internal use
3092 of the function check_config_exists)</li>
3093 </ul>
3094 </td>
3095 </tr>
3096 <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>
3097 </td>
3098 </tr>
3099 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Config</p>
3100 </td>
3101 </tr>
3102 </tbody>
3103 </table>
3104 </dd></dl>
3105
3106 <dl class="function">
3107 <dt id="src.product.get_product_dependencies">
3108 <tt class="descclassname">src.product.</tt><tt class="descname">get_product_dependencies</tt><big>(</big><em>config</em>, <em>product_info</em><big>)</big><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>
3109 <dd><p>Get recursively the list of products that are
3110 in the product_info dependencies</p>
3111 <table class="docutils field-list" frame="void" rules="none">
3112 <col class="field-name" />
3113 <col class="field-body" />
3114 <tbody valign="top">
3115 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
3116 <li><strong>Config</strong> (<em>product_info</em>) -- The global configuration</li>
3117 <li><strong>Config</strong> -- The configuration specific to
3118 the product</li>
3119 </ul>
3120 </td>
3121 </tr>
3122 <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>
3123 </td>
3124 </tr>
3125 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list</p>
3126 </td>
3127 </tr>
3128 </tbody>
3129 </table>
3130 </dd></dl>
3131
3132 <dl class="function">
3133 <dt id="src.product.get_product_section">
3134 <tt class="descclassname">src.product.</tt><tt class="descname">get_product_section</tt><big>(</big><em>config</em>, <em>product_name</em>, <em>version</em>, <em>section=None</em><big>)</big><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>
3135 <dd><p>Get the product description from the configuration</p>
3136 <table class="docutils field-list" frame="void" rules="none">
3137 <col class="field-name" />
3138 <col class="field-body" />
3139 <tbody valign="top">
3140 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
3141 <li><strong>Config</strong> (<em>config</em>) -- The global configuration</li>
3142 <li><strong>str</strong> (<em>section</em>) -- The product name</li>
3143 <li><strong>str</strong> -- The version of the product</li>
3144 <li><strong>str</strong> -- The searched section (if not None, the section is
3145 explicitly given</li>
3146 </ul>
3147 </td>
3148 </tr>
3149 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The product description</p>
3150 </td>
3151 </tr>
3152 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Config</p>
3153 </td>
3154 </tr>
3155 </tbody>
3156 </table>
3157 </dd></dl>
3158
3159 <dl class="function">
3160 <dt id="src.product.get_products_infos">
3161 <tt class="descclassname">src.product.</tt><tt class="descname">get_products_infos</tt><big>(</big><em>lproducts</em>, <em>config</em><big>)</big><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>
3162 <dd><p>Get the specific configuration of a list of products</p>
3163 <table class="docutils field-list" frame="void" rules="none">
3164 <col class="field-name" />
3165 <col class="field-body" />
3166 <tbody valign="top">
3167 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
3168 <li><strong>List</strong> (<em>lproducts</em>) -- The list of product names</li>
3169 <li><strong>Config</strong> (<em>config</em>) -- The global configuration</li>
3170 </ul>
3171 </td>
3172 </tr>
3173 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the list of tuples
3174 (product name, specific configuration of the product)</p>
3175 </td>
3176 </tr>
3177 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">[(str, Config)]</p>
3178 </td>
3179 </tr>
3180 </tbody>
3181 </table>
3182 </dd></dl>
3183
3184 <dl class="function">
3185 <dt id="src.product.product_compiles">
3186 <tt class="descclassname">src.product.</tt><tt class="descname">product_compiles</tt><big>(</big><em>product_info</em><big>)</big><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>
3187 <dd><p>Know if a product compiles or not
3188 (some products do not have a compilation procedure)</p>
3189 <table class="docutils field-list" frame="void" rules="none">
3190 <col class="field-name" />
3191 <col class="field-body" />
3192 <tbody valign="top">
3193 <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
3194 the product</td>
3195 </tr>
3196 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product compiles, else False</td>
3197 </tr>
3198 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3199 </tr>
3200 </tbody>
3201 </table>
3202 </dd></dl>
3203
3204 <dl class="function">
3205 <dt id="src.product.product_has_env_script">
3206 <tt class="descclassname">src.product.</tt><tt class="descname">product_has_env_script</tt><big>(</big><em>product_info</em><big>)</big><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>
3207 <dd><p>Know if a product has an environment script</p>
3208 <table class="docutils field-list" frame="void" rules="none">
3209 <col class="field-name" />
3210 <col class="field-body" />
3211 <tbody valign="top">
3212 <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
3213 the product</td>
3214 </tr>
3215 <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>
3216 </tr>
3217 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3218 </tr>
3219 </tbody>
3220 </table>
3221 </dd></dl>
3222
3223 <dl class="function">
3224 <dt id="src.product.product_has_logo">
3225 <tt class="descclassname">src.product.</tt><tt class="descname">product_has_logo</tt><big>(</big><em>product_info</em><big>)</big><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>
3226 <dd><p>Know if a product has a logo (YACSGEN generate)</p>
3227 <table class="docutils field-list" frame="void" rules="none">
3228 <col class="field-name" />
3229 <col class="field-body" />
3230 <tbody valign="top">
3231 <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
3232 the product</td>
3233 </tr>
3234 <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>
3235 </tr>
3236 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Str</td>
3237 </tr>
3238 </tbody>
3239 </table>
3240 </dd></dl>
3241
3242 <dl class="function">
3243 <dt id="src.product.product_has_patches">
3244 <tt class="descclassname">src.product.</tt><tt class="descname">product_has_patches</tt><big>(</big><em>product_info</em><big>)</big><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>
3245 <dd><p>Know if a product has one or more patches</p>
3246 <table class="docutils field-list" frame="void" rules="none">
3247 <col class="field-name" />
3248 <col class="field-body" />
3249 <tbody valign="top">
3250 <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
3251 the product</td>
3252 </tr>
3253 <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>
3254 </tr>
3255 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3256 </tr>
3257 </tbody>
3258 </table>
3259 </dd></dl>
3260
3261 <dl class="function">
3262 <dt id="src.product.product_has_salome_gui">
3263 <tt class="descclassname">src.product.</tt><tt class="descname">product_has_salome_gui</tt><big>(</big><em>product_info</em><big>)</big><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>
3264 <dd><p>Know if a product has a SALOME gui</p>
3265 <table class="docutils field-list" frame="void" rules="none">
3266 <col class="field-name" />
3267 <col class="field-body" />
3268 <tbody valign="top">
3269 <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
3270 the product</td>
3271 </tr>
3272 <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>
3273 </tr>
3274 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Boolean</td>
3275 </tr>
3276 </tbody>
3277 </table>
3278 </dd></dl>
3279
3280 <dl class="function">
3281 <dt id="src.product.product_has_script">
3282 <tt class="descclassname">src.product.</tt><tt class="descname">product_has_script</tt><big>(</big><em>product_info</em><big>)</big><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>
3283 <dd><p>Know if a product has a compilation script</p>
3284 <table class="docutils field-list" frame="void" rules="none">
3285 <col class="field-name" />
3286 <col class="field-body" />
3287 <tbody valign="top">
3288 <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
3289 the product</td>
3290 </tr>
3291 <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>
3292 </tr>
3293 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3294 </tr>
3295 </tbody>
3296 </table>
3297 </dd></dl>
3298
3299 <dl class="function">
3300 <dt id="src.product.product_is_autotools">
3301 <tt class="descclassname">src.product.</tt><tt class="descname">product_is_autotools</tt><big>(</big><em>product_info</em><big>)</big><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>
3302 <dd><p>Know if a product is compiled using the autotools</p>
3303 <table class="docutils field-list" frame="void" rules="none">
3304 <col class="field-name" />
3305 <col class="field-body" />
3306 <tbody valign="top">
3307 <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
3308 the product</td>
3309 </tr>
3310 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is autotools, else False</td>
3311 </tr>
3312 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3313 </tr>
3314 </tbody>
3315 </table>
3316 </dd></dl>
3317
3318 <dl class="function">
3319 <dt id="src.product.product_is_cmake">
3320 <tt class="descclassname">src.product.</tt><tt class="descname">product_is_cmake</tt><big>(</big><em>product_info</em><big>)</big><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>
3321 <dd><p>Know if a product is compiled using the cmake</p>
3322 <table class="docutils field-list" frame="void" rules="none">
3323 <col class="field-name" />
3324 <col class="field-body" />
3325 <tbody valign="top">
3326 <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
3327 the product</td>
3328 </tr>
3329 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is cmake, else False</td>
3330 </tr>
3331 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3332 </tr>
3333 </tbody>
3334 </table>
3335 </dd></dl>
3336
3337 <dl class="function">
3338 <dt id="src.product.product_is_cpp">
3339 <tt class="descclassname">src.product.</tt><tt class="descname">product_is_cpp</tt><big>(</big><em>product_info</em><big>)</big><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>
3340 <dd><p>Know if a product is cpp</p>
3341 <table class="docutils field-list" frame="void" rules="none">
3342 <col class="field-name" />
3343 <col class="field-body" />
3344 <tbody valign="top">
3345 <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
3346 the product</td>
3347 </tr>
3348 <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>
3349 </tr>
3350 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3351 </tr>
3352 </tbody>
3353 </table>
3354 </dd></dl>
3355
3356 <dl class="function">
3357 <dt id="src.product.product_is_debug">
3358 <tt class="descclassname">src.product.</tt><tt class="descname">product_is_debug</tt><big>(</big><em>product_info</em><big>)</big><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>
3359 <dd><p>Know if a product is in debug mode</p>
3360 <table class="docutils field-list" frame="void" rules="none">
3361 <col class="field-name" />
3362 <col class="field-body" />
3363 <tbody valign="top">
3364 <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
3365 the product</td>
3366 </tr>
3367 <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>
3368 </tr>
3369 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3370 </tr>
3371 </tbody>
3372 </table>
3373 </dd></dl>
3374
3375 <dl class="function">
3376 <dt id="src.product.product_is_dev">
3377 <tt class="descclassname">src.product.</tt><tt class="descname">product_is_dev</tt><big>(</big><em>product_info</em><big>)</big><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>
3378 <dd><p>Know if a product is in dev mode</p>
3379 <table class="docutils field-list" frame="void" rules="none">
3380 <col class="field-name" />
3381 <col class="field-body" />
3382 <tbody valign="top">
3383 <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
3384 the product</td>
3385 </tr>
3386 <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>
3387 </tr>
3388 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3389 </tr>
3390 </tbody>
3391 </table>
3392 </dd></dl>
3393
3394 <dl class="function">
3395 <dt id="src.product.product_is_fixed">
3396 <tt class="descclassname">src.product.</tt><tt class="descname">product_is_fixed</tt><big>(</big><em>product_info</em><big>)</big><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>
3397 <dd><p>Know if a product is fixed</p>
3398 <table class="docutils field-list" frame="void" rules="none">
3399 <col class="field-name" />
3400 <col class="field-body" />
3401 <tbody valign="top">
3402 <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
3403 the product</td>
3404 </tr>
3405 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is fixed, else False</td>
3406 </tr>
3407 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3408 </tr>
3409 </tbody>
3410 </table>
3411 </dd></dl>
3412
3413 <dl class="function">
3414 <dt id="src.product.product_is_generated">
3415 <tt class="descclassname">src.product.</tt><tt class="descname">product_is_generated</tt><big>(</big><em>product_info</em><big>)</big><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>
3416 <dd><p>Know if a product is generated (YACSGEN)</p>
3417 <table class="docutils field-list" frame="void" rules="none">
3418 <col class="field-name" />
3419 <col class="field-body" />
3420 <tbody valign="top">
3421 <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
3422 the product</td>
3423 </tr>
3424 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is generated</td>
3425 </tr>
3426 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3427 </tr>
3428 </tbody>
3429 </table>
3430 </dd></dl>
3431
3432 <dl class="function">
3433 <dt id="src.product.product_is_mpi">
3434 <tt class="descclassname">src.product.</tt><tt class="descname">product_is_mpi</tt><big>(</big><em>product_info</em><big>)</big><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>
3435 <dd><p>Know if a product has openmpi in its dependencies</p>
3436 <table class="docutils field-list" frame="void" rules="none">
3437 <col class="field-name" />
3438 <col class="field-body" />
3439 <tbody valign="top">
3440 <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
3441 the product</td>
3442 </tr>
3443 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product has openmpi inits dependencies</td>
3444 </tr>
3445 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3446 </tr>
3447 </tbody>
3448 </table>
3449 </dd></dl>
3450
3451 <dl class="function">
3452 <dt id="src.product.product_is_native">
3453 <tt class="descclassname">src.product.</tt><tt class="descname">product_is_native</tt><big>(</big><em>product_info</em><big>)</big><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>
3454 <dd><p>Know if a product is native</p>
3455 <table class="docutils field-list" frame="void" rules="none">
3456 <col class="field-name" />
3457 <col class="field-body" />
3458 <tbody valign="top">
3459 <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
3460 the product</td>
3461 </tr>
3462 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is native, else False</td>
3463 </tr>
3464 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3465 </tr>
3466 </tbody>
3467 </table>
3468 </dd></dl>
3469
3470 <dl class="function">
3471 <dt id="src.product.product_is_salome">
3472 <tt class="descclassname">src.product.</tt><tt class="descname">product_is_salome</tt><big>(</big><em>product_info</em><big>)</big><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>
3473 <dd><p>Know if a product is a SALOME module</p>
3474 <table class="docutils field-list" frame="void" rules="none">
3475 <col class="field-name" />
3476 <col class="field-body" />
3477 <tbody valign="top">
3478 <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
3479 the product</td>
3480 </tr>
3481 <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>
3482 </tr>
3483 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3484 </tr>
3485 </tbody>
3486 </table>
3487 </dd></dl>
3488
3489 <dl class="function">
3490 <dt id="src.product.product_is_sample">
3491 <tt class="descclassname">src.product.</tt><tt class="descname">product_is_sample</tt><big>(</big><em>product_info</em><big>)</big><a class="reference internal" href="../../_modules/src/product.html#product_is_sample"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#src.product.product_is_sample" title="Permalink to this definition">¶</a></dt>
3492 <dd><p>Know if a product has the sample type</p>
3493 <table class="docutils field-list" frame="void" rules="none">
3494 <col class="field-name" />
3495 <col class="field-body" />
3496 <tbody valign="top">
3497 <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
3498 the product</td>
3499 </tr>
3500 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product has the sample type, else False</td>
3501 </tr>
3502 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3503 </tr>
3504 </tbody>
3505 </table>
3506 </dd></dl>
3507
3508 <dl class="function">
3509 <dt id="src.product.product_is_smesh_plugin">
3510 <tt class="descclassname">src.product.</tt><tt class="descname">product_is_smesh_plugin</tt><big>(</big><em>product_info</em><big>)</big><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>
3511 <dd><p>Know if a product is a SMESH plugin</p>
3512 <table class="docutils field-list" frame="void" rules="none">
3513 <col class="field-name" />
3514 <col class="field-body" />
3515 <tbody valign="top">
3516 <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
3517 the product</td>
3518 </tr>
3519 <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>
3520 </tr>
3521 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3522 </tr>
3523 </tbody>
3524 </table>
3525 </dd></dl>
3526
3527 <dl class="function">
3528 <dt id="src.product.product_is_vcs">
3529 <tt class="descclassname">src.product.</tt><tt class="descname">product_is_vcs</tt><big>(</big><em>product_info</em><big>)</big><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>
3530 <dd><p>Know if a product is download using git, svn or cvs (not archive)</p>
3531 <table class="docutils field-list" frame="void" rules="none">
3532 <col class="field-name" />
3533 <col class="field-body" />
3534 <tbody valign="top">
3535 <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
3536 the product</td>
3537 </tr>
3538 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the product is vcs, else False</td>
3539 </tr>
3540 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
3541 </tr>
3542 </tbody>
3543 </table>
3544 </dd></dl>
3545
3546 </div>
3547 <div class="section" id="module-src.pyconf">
3548 <span id="pyconf-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">pyconf</span></tt> Module<a class="headerlink" href="#module-src.pyconf" title="Permalink to this headline">¶</a></h2>
3549 <p>This is a configuration module for Python.</p>
3550 <p>This module should work under Python versions &gt;= 2.2, and cannot be used with
3551 earlier versions since it uses new-style classes.</p>
3552 <p>Development and testing has only been carried out (so far) on Python 2.3.4 and
3553 Python 2.4.2. See the test module (test_config.py) included in the
3554 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
3555 download link).</p>
3556 <p>A simple example - with the example configuration file:</p>
3557 <div class="highlight-python"><pre>messages:
3558 [
3559   {
3560     stream : `sys.stderr`
3561     message: 'Welcome'
3562     name: 'Harry'
3563   }
3564   {
3565     stream : `sys.stdout`
3566     message: 'Welkom'
3567     name: 'Ruud'
3568   }
3569   {
3570     stream : $messages[0].stream
3571     message: 'Bienvenue'
3572     name: Yves
3573   }
3574 ]</pre>
3575 </div>
3576 <p>a program to read the configuration would be:</p>
3577 <div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">config</span> <span class="kn">import</span> <span class="n">Config</span>
3578
3579 <span class="n">f</span> <span class="o">=</span> <span class="nb">file</span><span class="p">(</span><span class="s">&#39;simple.cfg&#39;</span><span class="p">)</span>
3580 <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>
3581 <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>
3582     <span class="n">s</span> <span class="o">=</span> <span class="s">&#39;</span><span class="si">%s</span><span class="s">, </span><span class="si">%s</span><span class="s">&#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>
3583     <span class="k">try</span><span class="p">:</span>
3584         <span class="k">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>
3585     <span class="k">except</span> <span class="ne">IOError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
3586         <span class="k">print</span> <span class="n">e</span>
3587 </pre></div>
3588 </div>
3589 <p>which, when run, would yield the console output:</p>
3590 <div class="highlight-python"><div class="highlight"><pre><span class="n">Welcome</span><span class="p">,</span> <span class="n">Harry</span>
3591 <span class="n">Welkom</span><span class="p">,</span> <span class="n">Ruud</span>
3592 <span class="n">Bienvenue</span><span class="p">,</span> <span class="n">Yves</span>
3593 </pre></div>
3594 </div>
3595 <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
3596 information.</p>
3597 <p>#modified for salomeTools
3598 &#64;version: 0.3.7.1</p>
3599 <p>&#64;author: Vinay Sajip</p>
3600 <p>&#64;copyright: Copyright (C) 2004-2007 Vinay Sajip. All Rights Reserved.</p>
3601 <p>&#64;var streamOpener: The default stream opener. This is a factory function which
3602 takes a string (e.g. filename) and returns a stream suitable for reading. If
3603 unable to open the stream, an IOError exception should be thrown.</p>
3604 <p>The default value of this variable is L{defaultStreamOpener}. For an example
3605 of how it's used, see test_config.py (search for streamOpener).</p>
3606 <dl class="class">
3607 <dt id="src.pyconf.Config">
3608 <em class="property">class </em><tt class="descclassname">src.pyconf.</tt><tt class="descname">Config</tt><big>(</big><em>streamOrFile=None</em>, <em>parent=None</em>, <em>PWD=None</em><big>)</big><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>
3609 <dd><p>Bases: <a class="reference internal" href="#src.pyconf.Mapping" title="src.pyconf.Mapping"><tt class="xref py py-class docutils literal"><span class="pre">src.pyconf.Mapping</span></tt></a></p>
3610 <p>This class represents a configuration, and is the only one which clients
3611 need to interface to, under normal circumstances.</p>
3612 <dl class="class">
3613 <dt id="src.pyconf.Config.Namespace">
3614 <em class="property">class </em><tt class="descname">Namespace</tt><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>
3615 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
3616 <p>This internal class is used for implementing default namespaces.</p>
3617 <p>An instance acts as a namespace.</p>
3618 </dd></dl>
3619
3620 <dl class="method">
3621 <dt id="src.pyconf.Config.addNamespace">
3622 <tt class="descclassname">Config.</tt><tt class="descname">addNamespace</tt><big>(</big><em>ns</em>, <em>name=None</em><big>)</big><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>
3623 <dd><p>Add a namespace to this configuration which can be used to evaluate
3624 (resolve) dotted-identifier expressions.
3625 &#64;param ns: The namespace to be added.
3626 &#64;type ns: A module or other namespace suitable for passing as an
3627 argument to vars().
3628 &#64;param name: A name for the namespace, which, if specified, provides
3629 an additional level of indirection.
3630 &#64;type name: str</p>
3631 </dd></dl>
3632
3633 <dl class="method">
3634 <dt id="src.pyconf.Config.getByPath">
3635 <tt class="descclassname">Config.</tt><tt class="descname">getByPath</tt><big>(</big><em>path</em><big>)</big><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>
3636 <dd><p>Obtain a value in the configuration via its path.
3637 &#64;param path: The path of the required value
3638 &#64;type path: str
3639 &#64;return the value at the specified path.
3640 &#64;rtype: any
3641 &#64;raise ConfigError: If the path is invalid</p>
3642 </dd></dl>
3643
3644 <dl class="method">
3645 <dt id="src.pyconf.Config.load">
3646 <tt class="descclassname">Config.</tt><tt class="descname">load</tt><big>(</big><em>stream</em><big>)</big><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>
3647 <dd><p>Load the configuration from the specified stream. Multiple streams can
3648 be used to populate the same instance, as long as there are no
3649 clashing keys. The stream is closed.
3650 &#64;param stream: A stream from which the configuration is read.
3651 &#64;type stream: A read-only stream (file-like object).
3652 &#64;raise ConfigError: if keys in the loaded configuration clash with
3653 existing keys.
3654 &#64;raise ConfigFormatError: if there is a syntax error in the stream.</p>
3655 </dd></dl>
3656
3657 <dl class="method">
3658 <dt id="src.pyconf.Config.removeNamespace">
3659 <tt class="descclassname">Config.</tt><tt class="descname">removeNamespace</tt><big>(</big><em>ns</em>, <em>name=None</em><big>)</big><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>
3660 <dd><p>Remove a namespace added with L{addNamespace}.
3661 &#64;param ns: The namespace to be removed.
3662 &#64;param name: The name which was specified when L{addNamespace} was
3663 called.
3664 &#64;type name: str</p>
3665 </dd></dl>
3666
3667 </dd></dl>
3668
3669 <dl class="exception">
3670 <dt id="src.pyconf.ConfigError">
3671 <em class="property">exception </em><tt class="descclassname">src.pyconf.</tt><tt class="descname">ConfigError</tt><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>
3672 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p>
3673 <p>This is the base class of exceptions raised by this module.</p>
3674 </dd></dl>
3675
3676 <dl class="exception">
3677 <dt id="src.pyconf.ConfigFormatError">
3678 <em class="property">exception </em><tt class="descclassname">src.pyconf.</tt><tt class="descname">ConfigFormatError</tt><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>
3679 <dd><p>Bases: <a class="reference internal" href="#src.pyconf.ConfigError" title="src.pyconf.ConfigError"><tt class="xref py py-class docutils literal"><span class="pre">src.pyconf.ConfigError</span></tt></a></p>
3680 <p>This is the base class of exceptions raised due to syntax errors in
3681 configurations.</p>
3682 </dd></dl>
3683
3684 <dl class="class">
3685 <dt id="src.pyconf.ConfigInputStream">
3686 <em class="property">class </em><tt class="descclassname">src.pyconf.</tt><tt class="descname">ConfigInputStream</tt><big>(</big><em>stream</em><big>)</big><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>
3687 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
3688 <p>An input stream which can read either ANSI files with default encoding
3689 or Unicode files with BOMs.</p>
3690 <p>Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
3691 built-in support.</p>
3692 <dl class="method">
3693 <dt id="src.pyconf.ConfigInputStream.close">
3694 <tt class="descname">close</tt><big>(</big><big>)</big><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>
3695 <dd></dd></dl>
3696
3697 <dl class="method">
3698 <dt id="src.pyconf.ConfigInputStream.read">
3699 <tt class="descname">read</tt><big>(</big><em>size</em><big>)</big><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>
3700 <dd></dd></dl>
3701
3702 <dl class="method">
3703 <dt id="src.pyconf.ConfigInputStream.readline">
3704 <tt class="descname">readline</tt><big>(</big><big>)</big><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>
3705 <dd></dd></dl>
3706
3707 </dd></dl>
3708
3709 <dl class="class">
3710 <dt id="src.pyconf.ConfigList">
3711 <em class="property">class </em><tt class="descclassname">src.pyconf.</tt><tt class="descname">ConfigList</tt><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>
3712 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></p>
3713 <p>This class implements an ordered list of configurations and allows you
3714 to try getting the configuration from each entry in turn, returning
3715 the first successfully obtained value.</p>
3716 <dl class="method">
3717 <dt id="src.pyconf.ConfigList.getByPath">
3718 <tt class="descname">getByPath</tt><big>(</big><em>path</em><big>)</big><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>
3719 <dd><p>Obtain a value from the first configuration in the list which defines
3720 it.</p>
3721 <p>&#64;param path: The path of the value to retrieve.
3722 &#64;type path: str
3723 &#64;return: The value from the earliest configuration in the list which
3724 defines it.
3725 &#64;rtype: any
3726 &#64;raise ConfigError: If no configuration in the list has an entry with
3727 the specified path.</p>
3728 </dd></dl>
3729
3730 </dd></dl>
3731
3732 <dl class="class">
3733 <dt id="src.pyconf.ConfigMerger">
3734 <em class="property">class </em><tt class="descclassname">src.pyconf.</tt><tt class="descname">ConfigMerger</tt><big>(</big><em>resolver=&lt;function defaultMergeResolve at 0x2379de8&gt;</em><big>)</big><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>
3735 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
3736 <p>This class is used for merging two configurations. If a key exists in the
3737 merge operand but not the merge target, then the entry is copied from the
3738 merge operand to the merge target. If a key exists in both configurations,
3739 then a resolver (a callable) is called to decide how to handle the
3740 conflict.</p>
3741 <dl class="method">
3742 <dt id="src.pyconf.ConfigMerger.handleMismatch">
3743 <tt class="descname">handleMismatch</tt><big>(</big><em>obj1</em>, <em>obj2</em><big>)</big><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>
3744 <dd><p>Handle a mismatch between two objects.</p>
3745 <p>&#64;param obj1: The object to merge into.
3746 &#64;type obj1: any
3747 &#64;param obj2: The object to merge.
3748 &#64;type obj2: any</p>
3749 </dd></dl>
3750
3751 <dl class="method">
3752 <dt id="src.pyconf.ConfigMerger.merge">
3753 <tt class="descname">merge</tt><big>(</big><em>merged</em>, <em>mergee</em><big>)</big><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>
3754 <dd><p>Merge two configurations. The second configuration is unchanged,
3755 and the first is changed to reflect the results of the merge.</p>
3756 <p>&#64;param merged: The configuration to merge into.
3757 &#64;type merged: L{Config}.
3758 &#64;param mergee: The configuration to merge.
3759 &#64;type mergee: L{Config}.</p>
3760 </dd></dl>
3761
3762 <dl class="method">
3763 <dt id="src.pyconf.ConfigMerger.mergeMapping">
3764 <tt class="descname">mergeMapping</tt><big>(</big><em>map1</em>, <em>map2</em><big>)</big><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>
3765 <dd><p>Merge two mappings recursively. The second mapping is unchanged,
3766 and the first is changed to reflect the results of the merge.</p>
3767 <p>&#64;param map1: The mapping to merge into.
3768 &#64;type map1: L{Mapping}.
3769 &#64;param map2: The mapping to merge.
3770 &#64;type map2: L{Mapping}.</p>
3771 </dd></dl>
3772
3773 <dl class="method">
3774 <dt id="src.pyconf.ConfigMerger.mergeSequence">
3775 <tt class="descname">mergeSequence</tt><big>(</big><em>seq1</em>, <em>seq2</em><big>)</big><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>
3776 <dd><p>Merge two sequences. The second sequence is unchanged,
3777 and the first is changed to have the elements of the second
3778 appended to it.</p>
3779 <p>&#64;param seq1: The sequence to merge into.
3780 &#64;type seq1: L{Sequence}.
3781 &#64;param seq2: The sequence to merge.
3782 &#64;type seq2: L{Sequence}.</p>
3783 </dd></dl>
3784
3785 <dl class="method">
3786 <dt id="src.pyconf.ConfigMerger.overwriteKeys">
3787 <tt class="descname">overwriteKeys</tt><big>(</big><em>map1</em>, <em>seq2</em><big>)</big><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>
3788 <dd><p>Renint variables. The second mapping is unchanged,
3789 and the first is changed depending the keys of the second mapping.
3790 &#64;param map1: The mapping to reinit keys into.
3791 &#64;type map1: L{Mapping}.
3792 &#64;param map2: The mapping container reinit information.
3793 &#64;type map2: L{Mapping}.</p>
3794 </dd></dl>
3795
3796 </dd></dl>
3797
3798 <dl class="class">
3799 <dt id="src.pyconf.ConfigOutputStream">
3800 <em class="property">class </em><tt class="descclassname">src.pyconf.</tt><tt class="descname">ConfigOutputStream</tt><big>(</big><em>stream</em>, <em>encoding=None</em><big>)</big><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>
3801 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
3802 <p>An output stream which can write either ANSI files with default encoding
3803 or Unicode files with BOMs.</p>
3804 <p>Handles UTF-8, UTF-16LE, UTF-16BE. Could handle UTF-32 if Python had
3805 built-in support.</p>
3806 <dl class="method">
3807 <dt id="src.pyconf.ConfigOutputStream.close">
3808 <tt class="descname">close</tt><big>(</big><big>)</big><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>
3809 <dd></dd></dl>
3810
3811 <dl class="method">
3812 <dt id="src.pyconf.ConfigOutputStream.flush">
3813 <tt class="descname">flush</tt><big>(</big><big>)</big><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>
3814 <dd></dd></dl>
3815
3816 <dl class="method">
3817 <dt id="src.pyconf.ConfigOutputStream.write">
3818 <tt class="descname">write</tt><big>(</big><em>data</em><big>)</big><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>
3819 <dd></dd></dl>
3820
3821 </dd></dl>
3822
3823 <dl class="class">
3824 <dt id="src.pyconf.ConfigReader">
3825 <em class="property">class </em><tt class="descclassname">src.pyconf.</tt><tt class="descname">ConfigReader</tt><big>(</big><em>config</em><big>)</big><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>
3826 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
3827 <p>This internal class implements a parser for configurations.</p>
3828 <dl class="method">
3829 <dt id="src.pyconf.ConfigReader.getChar">
3830 <tt class="descname">getChar</tt><big>(</big><big>)</big><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>
3831 <dd><p>Get the next char from the stream. Update line and column numbers
3832 appropriately.</p>
3833 <p>&#64;return: The next character from the stream.
3834 &#64;rtype: str</p>
3835 </dd></dl>
3836
3837 <dl class="method">
3838 <dt id="src.pyconf.ConfigReader.getToken">
3839 <tt class="descname">getToken</tt><big>(</big><big>)</big><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>
3840 <dd><p>Get a token from the stream. String values are returned in a form
3841 where you need to eval() the returned value to get the actual
3842 string. The return value is (token_type, token_value).</p>
3843 <p>Multiline string tokenizing is thanks to David Janes (BlogMatrix)</p>
3844 <p>&#64;return: The next token.
3845 &#64;rtype: A token tuple.</p>
3846 </dd></dl>
3847
3848 <dl class="method">
3849 <dt id="src.pyconf.ConfigReader.load">
3850 <tt class="descname">load</tt><big>(</big><em>stream</em>, <em>parent=None</em>, <em>suffix=None</em><big>)</big><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>
3851 <dd><p>Load the configuration from the specified stream.</p>
3852 <p>&#64;param stream: A stream from which to load the configuration.
3853 &#64;type stream: A stream (file-like object).
3854 &#64;param parent: The parent of the configuration (to which this reader
3855 belongs) in the hierarchy. Specified when the configuration is
3856 included in another one.
3857 &#64;type parent: A L{Container} instance.
3858 &#64;param suffix: The suffix of this configuration in the parent
3859 configuration. Should be specified whenever the parent is not None.
3860 &#64;raise ConfigError: If parent is specified but suffix is not.
3861 &#64;raise ConfigFormatError: If there are syntax errors in the stream.</p>
3862 </dd></dl>
3863
3864 <dl class="method">
3865 <dt id="src.pyconf.ConfigReader.location">
3866 <tt class="descname">location</tt><big>(</big><big>)</big><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>
3867 <dd><p>Return the current location (filename, line, column) in the stream
3868 as a string.</p>
3869 <p>Used when printing error messages,</p>
3870 <p>&#64;return: A string representing a location in the stream being read.
3871 &#64;rtype: str</p>
3872 </dd></dl>
3873
3874 <dl class="method">
3875 <dt id="src.pyconf.ConfigReader.match">
3876 <tt class="descname">match</tt><big>(</big><em>t</em><big>)</big><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>
3877 <dd><p>Ensure that the current token type matches the specified value, and
3878 advance to the next token.</p>
3879 <p>&#64;param t: The token type to match.
3880 &#64;type t: A valid token type.
3881 &#64;return: The token which was last read from the stream before this
3882 function is called.
3883 &#64;rtype: a token tuple - see L{getToken}.
3884 &#64;raise ConfigFormatError: If the token does not match what's expected.</p>
3885 </dd></dl>
3886
3887 <dl class="method">
3888 <dt id="src.pyconf.ConfigReader.parseFactor">
3889 <tt class="descname">parseFactor</tt><big>(</big><big>)</big><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>
3890 <dd><p>Parse a factor in an multiplicative expression (a * b, a / b, a % b)</p>
3891 <p>&#64;return: the parsed factor
3892 &#64;rtype: any scalar
3893 &#64;raise ConfigFormatError: if a syntax error is found.</p>
3894 </dd></dl>
3895
3896 <dl class="method">
3897 <dt id="src.pyconf.ConfigReader.parseKeyValuePair">
3898 <tt class="descname">parseKeyValuePair</tt><big>(</big><em>parent</em><big>)</big><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>
3899 <dd><p>Parse a key-value pair, and add it to the provided L{Mapping}.</p>
3900 <p>&#64;param parent: The mapping to add entries to.
3901 &#64;type parent: A L{Mapping} instance.
3902 &#64;raise ConfigFormatError: if a syntax error is found.</p>
3903 </dd></dl>
3904
3905 <dl class="method">
3906 <dt id="src.pyconf.ConfigReader.parseMapping">
3907 <tt class="descname">parseMapping</tt><big>(</big><em>parent</em>, <em>suffix</em><big>)</big><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>
3908 <dd><p>Parse a mapping.</p>
3909 <p>&#64;param parent: The container to which the mapping will be added.
3910 &#64;type parent: A L{Container} instance.
3911 &#64;param suffix: The suffix for the value.
3912 &#64;type suffix: str
3913 &#64;return: a L{Mapping} instance representing the mapping.
3914 &#64;rtype: L{Mapping}
3915 &#64;raise ConfigFormatError: if a syntax error is found.</p>
3916 </dd></dl>
3917
3918 <dl class="method">
3919 <dt id="src.pyconf.ConfigReader.parseMappingBody">
3920 <tt class="descname">parseMappingBody</tt><big>(</big><em>parent</em><big>)</big><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>
3921 <dd><p>Parse the internals of a mapping, and add entries to the provided
3922 L{Mapping}.</p>
3923 <p>&#64;param parent: The mapping to add entries to.
3924 &#64;type parent: A L{Mapping} instance.</p>
3925 </dd></dl>
3926
3927 <dl class="method">
3928 <dt id="src.pyconf.ConfigReader.parseReference">
3929 <tt class="descname">parseReference</tt><big>(</big><em>type</em><big>)</big><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>
3930 <dd><p>Parse a reference.</p>
3931 <p>&#64;return: the parsed reference
3932 &#64;rtype: L{Reference}
3933 &#64;raise ConfigFormatError: if a syntax error is found.</p>
3934 </dd></dl>
3935
3936 <dl class="method">
3937 <dt id="src.pyconf.ConfigReader.parseScalar">
3938 <tt class="descname">parseScalar</tt><big>(</big><big>)</big><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>
3939 <dd><p>Parse a scalar - a terminal value such as a string or number, or
3940 an L{Expression} or L{Reference}.</p>
3941 <p>&#64;return: the parsed scalar
3942 &#64;rtype: any scalar
3943 &#64;raise ConfigFormatError: if a syntax error is found.</p>
3944 </dd></dl>
3945
3946 <dl class="method">
3947 <dt id="src.pyconf.ConfigReader.parseSequence">
3948 <tt class="descname">parseSequence</tt><big>(</big><em>parent</em>, <em>suffix</em><big>)</big><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>
3949 <dd><p>Parse a sequence.</p>
3950 <p>&#64;param parent: The container to which the sequence will be added.
3951 &#64;type parent: A L{Container} instance.
3952 &#64;param suffix: The suffix for the value.
3953 &#64;type suffix: str
3954 &#64;return: a L{Sequence} instance representing the sequence.
3955 &#64;rtype: L{Sequence}
3956 &#64;raise ConfigFormatError: if a syntax error is found.</p>
3957 </dd></dl>
3958
3959 <dl class="method">
3960 <dt id="src.pyconf.ConfigReader.parseSuffix">
3961 <tt class="descname">parseSuffix</tt><big>(</big><em>ref</em><big>)</big><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>
3962 <dd><p>Parse a reference suffix.</p>
3963 <p>&#64;param ref: The reference of which this suffix is a part.
3964 &#64;type ref: L{Reference}.
3965 &#64;raise ConfigFormatError: if a syntax error is found.</p>
3966 </dd></dl>
3967
3968 <dl class="method">
3969 <dt id="src.pyconf.ConfigReader.parseTerm">
3970 <tt class="descname">parseTerm</tt><big>(</big><big>)</big><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>
3971 <dd><p>Parse a term in an additive expression (a + b, a - b)</p>
3972 <p>&#64;return: the parsed term
3973 &#64;rtype: any scalar
3974 &#64;raise ConfigFormatError: if a syntax error is found.</p>
3975 </dd></dl>
3976
3977 <dl class="method">
3978 <dt id="src.pyconf.ConfigReader.parseValue">
3979 <tt class="descname">parseValue</tt><big>(</big><em>parent</em>, <em>suffix</em><big>)</big><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>
3980 <dd><p>Parse a value.</p>
3981 <p>&#64;param parent: The container to which the value will be added.
3982 &#64;type parent: A L{Container} instance.
3983 &#64;param suffix: The suffix for the value.
3984 &#64;type suffix: str
3985 &#64;return: The value
3986 &#64;rtype: any
3987 &#64;raise ConfigFormatError: if a syntax error is found.</p>
3988 </dd></dl>
3989
3990 <dl class="method">
3991 <dt id="src.pyconf.ConfigReader.setStream">
3992 <tt class="descname">setStream</tt><big>(</big><em>stream</em><big>)</big><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>
3993 <dd><p>Set the stream to the specified value, and prepare to read from it.</p>
3994 <p>&#64;param stream: A stream from which to load the configuration.
3995 &#64;type stream: A stream (file-like object).</p>
3996 </dd></dl>
3997
3998 </dd></dl>
3999
4000 <dl class="exception">
4001 <dt id="src.pyconf.ConfigResolutionError">
4002 <em class="property">exception </em><tt class="descclassname">src.pyconf.</tt><tt class="descname">ConfigResolutionError</tt><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>
4003 <dd><p>Bases: <a class="reference internal" href="#src.pyconf.ConfigError" title="src.pyconf.ConfigError"><tt class="xref py py-class docutils literal"><span class="pre">src.pyconf.ConfigError</span></tt></a></p>
4004 <p>This is the base class of exceptions raised due to semantic errors in
4005 configurations.</p>
4006 </dd></dl>
4007
4008 <dl class="class">
4009 <dt id="src.pyconf.Container">
4010 <em class="property">class </em><tt class="descclassname">src.pyconf.</tt><tt class="descname">Container</tt><big>(</big><em>parent</em><big>)</big><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>
4011 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
4012 <p>This internal class is the base class for mappings and sequences.</p>
4013 <p>&#64;ivar path: A string which describes how to get
4014 to this instance from the root of the hierarchy.</p>
4015 <p>Example:</p>
4016 <div class="highlight-python"><pre>a.list.of[1].or['more'].elements</pre>
4017 </div>
4018 <dl class="method">
4019 <dt id="src.pyconf.Container.evaluate">
4020 <tt class="descname">evaluate</tt><big>(</big><em>item</em><big>)</big><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>
4021 <dd><p>Evaluate items which are instances of L{Reference} or L{Expression}.</p>
4022 <p>L{Reference} instances are evaluated using L{Reference.resolve},
4023 and L{Expression} instances are evaluated using
4024 L{Expression.evaluate}.</p>
4025 <p>&#64;param item: The item to be evaluated.
4026 &#64;type item: any
4027 &#64;return: If the item is an instance of L{Reference} or L{Expression},
4028 the evaluated value is returned, otherwise the item is returned
4029 unchanged.</p>
4030 </dd></dl>
4031
4032 <dl class="method">
4033 <dt id="src.pyconf.Container.setPath">
4034 <tt class="descname">setPath</tt><big>(</big><em>path</em><big>)</big><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>
4035 <dd><p>Set the path for this instance.
4036 &#64;param path: The path - a string which describes how to get
4037 to this instance from the root of the hierarchy.
4038 &#64;type path: str</p>
4039 </dd></dl>
4040
4041 <dl class="method">
4042 <dt id="src.pyconf.Container.writeToStream">
4043 <tt class="descname">writeToStream</tt><big>(</big><em>stream</em>, <em>indent</em>, <em>container</em><big>)</big><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>
4044 <dd><p>Write this instance to a stream at the specified indentation level.</p>
4045 <p>Should be redefined in subclasses.</p>
4046 <p>&#64;param stream: The stream to write to
4047 &#64;type stream: A writable stream (file-like object)
4048 &#64;param indent: The indentation level
4049 &#64;type indent: int
4050 &#64;param container: The container of this instance
4051 &#64;type container: L{Container}
4052 &#64;raise NotImplementedError: If a subclass does not override this</p>
4053 </dd></dl>
4054
4055 <dl class="method">
4056 <dt id="src.pyconf.Container.writeValue">
4057 <tt class="descname">writeValue</tt><big>(</big><em>value</em>, <em>stream</em>, <em>indent</em><big>)</big><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>
4058 <dd></dd></dl>
4059
4060 </dd></dl>
4061
4062 <dl class="class">
4063 <dt id="src.pyconf.Expression">
4064 <em class="property">class </em><tt class="descclassname">src.pyconf.</tt><tt class="descname">Expression</tt><big>(</big><em>op</em>, <em>lhs</em>, <em>rhs</em><big>)</big><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>
4065 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
4066 <p>This internal class implements a value which is obtained by evaluating an expression.</p>
4067 <dl class="method">
4068 <dt id="src.pyconf.Expression.evaluate">
4069 <tt class="descname">evaluate</tt><big>(</big><em>container</em><big>)</big><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>
4070 <dd><p>Evaluate this instance in the context of a container.</p>
4071 <p>&#64;param container: The container to evaluate in from.
4072 &#64;type container: L{Container}
4073 &#64;return: The evaluated value.
4074 &#64;rtype: any
4075 &#64;raise ConfigResolutionError: If evaluation fails.
4076 &#64;raise ZeroDivideError: If division by zero occurs.
4077 &#64;raise TypeError: If the operation is invalid, e.g.
4078 subtracting one string from another.</p>
4079 </dd></dl>
4080
4081 </dd></dl>
4082
4083 <dl class="class">
4084 <dt id="src.pyconf.Mapping">
4085 <em class="property">class </em><tt class="descclassname">src.pyconf.</tt><tt class="descname">Mapping</tt><big>(</big><em>parent=None</em><big>)</big><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>
4086 <dd><p>Bases: <a class="reference internal" href="#src.pyconf.Container" title="src.pyconf.Container"><tt class="xref py py-class docutils literal"><span class="pre">src.pyconf.Container</span></tt></a></p>
4087 <p>This internal class implements key-value mappings in configurations.</p>
4088 <dl class="method">
4089 <dt id="src.pyconf.Mapping.addMapping">
4090 <tt class="descname">addMapping</tt><big>(</big><em>key</em>, <em>value</em>, <em>comment</em>, <em>setting=False</em><big>)</big><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>
4091 <dd><p>Add a key-value mapping with a comment.</p>
4092 <p>&#64;param key: The key for the mapping.
4093 &#64;type key: str
4094 &#64;param value: The value for the mapping.
4095 &#64;type value: any
4096 &#64;param comment: The comment for the key (can be None).
4097 &#64;type comment: str
4098 &#64;param setting: If True, ignore clashes. This is set
4099 to true when called from L{__setattr__}.
4100 &#64;raise ConfigFormatError: If an existing key is seen
4101 again and setting is False.</p>
4102 </dd></dl>
4103
4104 <dl class="method">
4105 <dt id="src.pyconf.Mapping.get">
4106 <tt class="descname">get</tt><big>(</big><em>key</em>, <em>default=None</em><big>)</big><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>
4107 <dd><p>Allows a dictionary-style get operation.</p>
4108 </dd></dl>
4109
4110 <dl class="method">
4111 <dt id="src.pyconf.Mapping.iteritems">
4112 <tt class="descname">iteritems</tt><big>(</big><big>)</big><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>
4113 <dd></dd></dl>
4114
4115 <dl class="method">
4116 <dt id="src.pyconf.Mapping.iterkeys">
4117 <tt class="descname">iterkeys</tt><big>(</big><big>)</big><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>
4118 <dd></dd></dl>
4119
4120 <dl class="method">
4121 <dt id="src.pyconf.Mapping.keys">
4122 <tt class="descname">keys</tt><big>(</big><big>)</big><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>
4123 <dd><p>Return the keys in a similar way to a dictionary.</p>
4124 </dd></dl>
4125
4126 <dl class="method">
4127 <dt id="src.pyconf.Mapping.writeToStream">
4128 <tt class="descname">writeToStream</tt><big>(</big><em>stream</em>, <em>indent</em>, <em>container</em><big>)</big><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>
4129 <dd><p>Write this instance to a stream at the specified indentation level.</p>
4130 <p>Should be redefined in subclasses.</p>
4131 <p>&#64;param stream: The stream to write to
4132 &#64;type stream: A writable stream (file-like object)
4133 &#64;param indent: The indentation level
4134 &#64;type indent: int
4135 &#64;param container: The container of this instance
4136 &#64;type container: L{Container}</p>
4137 </dd></dl>
4138
4139 </dd></dl>
4140
4141 <dl class="class">
4142 <dt id="src.pyconf.Reference">
4143 <em class="property">class </em><tt class="descclassname">src.pyconf.</tt><tt class="descname">Reference</tt><big>(</big><em>config</em>, <em>type</em>, <em>ident</em><big>)</big><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>
4144 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
4145 <p>This internal class implements a value which is a reference to another value.</p>
4146 <dl class="method">
4147 <dt id="src.pyconf.Reference.addElement">
4148 <tt class="descname">addElement</tt><big>(</big><em>type</em>, <em>ident</em><big>)</big><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>
4149 <dd><p>Add an element to the reference.</p>
4150 <p>&#64;param type: The type of reference.
4151 &#64;type type: BACKTICK or DOLLAR
4152 &#64;param ident: The identifier which continues the reference.
4153 &#64;type ident: str</p>
4154 </dd></dl>
4155
4156 <dl class="method">
4157 <dt id="src.pyconf.Reference.findConfig">
4158 <tt class="descname">findConfig</tt><big>(</big><em>container</em><big>)</big><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>
4159 <dd><p>Find the closest enclosing configuration to the specified container.</p>
4160 <p>&#64;param container: The container to start from.
4161 &#64;type container: L{Container}
4162 &#64;return: The closest enclosing configuration, or None.
4163 &#64;rtype: L{Config}</p>
4164 </dd></dl>
4165
4166 <dl class="method">
4167 <dt id="src.pyconf.Reference.resolve">
4168 <tt class="descname">resolve</tt><big>(</big><em>container</em><big>)</big><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>
4169 <dd><p>Resolve this instance in the context of a container.</p>
4170 <p>&#64;param container: The container to resolve from.
4171 &#64;type container: L{Container}
4172 &#64;return: The resolved value.
4173 &#64;rtype: any
4174 &#64;raise ConfigResolutionError: If resolution fails.</p>
4175 </dd></dl>
4176
4177 </dd></dl>
4178
4179 <dl class="class">
4180 <dt id="src.pyconf.Sequence">
4181 <em class="property">class </em><tt class="descclassname">src.pyconf.</tt><tt class="descname">Sequence</tt><big>(</big><em>parent=None</em><big>)</big><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>
4182 <dd><p>Bases: <a class="reference internal" href="#src.pyconf.Container" title="src.pyconf.Container"><tt class="xref py py-class docutils literal"><span class="pre">src.pyconf.Container</span></tt></a></p>
4183 <p>This internal class implements a value which is a sequence of other values.</p>
4184 <dl class="class">
4185 <dt id="src.pyconf.Sequence.SeqIter">
4186 <em class="property">class </em><tt class="descname">SeqIter</tt><big>(</big><em>seq</em><big>)</big><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>
4187 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
4188 <p>This internal class implements an iterator for a L{Sequence} instance.</p>
4189 <dl class="method">
4190 <dt id="src.pyconf.Sequence.SeqIter.next">
4191 <tt class="descname">next</tt><big>(</big><big>)</big><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>
4192 <dd></dd></dl>
4193
4194 </dd></dl>
4195
4196 <dl class="method">
4197 <dt id="src.pyconf.Sequence.append">
4198 <tt class="descclassname">Sequence.</tt><tt class="descname">append</tt><big>(</big><em>item</em>, <em>comment</em><big>)</big><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>
4199 <dd><p>Add an item to the sequence.</p>
4200 <p>&#64;param item: The item to add.
4201 &#64;type item: any
4202 &#64;param comment: A comment for the item.
4203 &#64;type comment: str</p>
4204 </dd></dl>
4205
4206 <dl class="method">
4207 <dt id="src.pyconf.Sequence.writeToStream">
4208 <tt class="descclassname">Sequence.</tt><tt class="descname">writeToStream</tt><big>(</big><em>stream</em>, <em>indent</em>, <em>container</em><big>)</big><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>
4209 <dd><p>Write this instance to a stream at the specified indentation level.</p>
4210 <p>Should be redefined in subclasses.</p>
4211 <p>&#64;param stream: The stream to write to
4212 &#64;type stream: A writable stream (file-like object)
4213 &#64;param indent: The indentation level
4214 &#64;type indent: int
4215 &#64;param container: The container of this instance
4216 &#64;type container: L{Container}</p>
4217 </dd></dl>
4218
4219 </dd></dl>
4220
4221 <dl class="function">
4222 <dt id="src.pyconf.deepCopyMapping">
4223 <tt class="descclassname">src.pyconf.</tt><tt class="descname">deepCopyMapping</tt><big>(</big><em>inMapping</em><big>)</big><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>
4224 <dd></dd></dl>
4225
4226 <dl class="function">
4227 <dt id="src.pyconf.defaultMergeResolve">
4228 <tt class="descclassname">src.pyconf.</tt><tt class="descname">defaultMergeResolve</tt><big>(</big><em>map1</em>, <em>map2</em>, <em>key</em><big>)</big><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>
4229 <dd><p>A default resolver for merge conflicts.
4230 Returns a string indicating what action to take to resolve the conflict.</p>
4231 <p>&#64;param map1: The map being merged into.
4232 &#64;type map1: L{Mapping}.
4233 &#64;param map2: The map being used as the merge operand.
4234 &#64;type map2: L{Mapping}.
4235 &#64;param key: The key in map2 (which also exists in map1).
4236 &#64;type key: str</p>
4237 <dl class="docutils">
4238 <dt>&#64;return: One of &quot;merge&quot;, &quot;append&quot;, &quot;mismatch&quot; or &quot;overwrite&quot;</dt>
4239 <dd>indicating what action should be taken. This should
4240 be appropriate to the objects being merged - e.g.
4241 there is no point returning &quot;merge&quot; if the two objects
4242 are instances of L{Sequence}.</dd>
4243 </dl>
4244 <p>&#64;rtype: str</p>
4245 </dd></dl>
4246
4247 <dl class="function">
4248 <dt id="src.pyconf.defaultStreamOpener">
4249 <tt class="descclassname">src.pyconf.</tt><tt class="descname">defaultStreamOpener</tt><big>(</big><em>name</em><big>)</big><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>
4250 <dd><p>This function returns a read-only stream, given its name. The name passed
4251 in should correspond to an existing stream, otherwise an exception will be
4252 raised.</p>
4253 <p>This is the default value of L{streamOpener}; assign your own callable to
4254 streamOpener to return streams based on names. For example, you could use
4255 urllib2.urlopen().</p>
4256 <p>&#64;param name: The name of a stream, most commonly a file name.
4257 &#64;type name: str
4258 &#64;return: A stream with the specified name.
4259 &#64;rtype: A read-only stream (file-like object)</p>
4260 </dd></dl>
4261
4262 <dl class="function">
4263 <dt id="src.pyconf.isWord">
4264 <tt class="descclassname">src.pyconf.</tt><tt class="descname">isWord</tt><big>(</big><em>s</em><big>)</big><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>
4265 <dd><p>See if a passed-in value is an identifier. If the value passed in is not a
4266 string, False is returned. An identifier consists of alphanumerics or
4267 underscore characters.</p>
4268 <p>Examples:</p>
4269 <div class="highlight-python"><pre>isWord('a word') -&gt;False
4270 isWord('award') -&gt; True
4271 isWord(9) -&gt; False
4272 isWord('a_b_c_') -&gt;True</pre>
4273 </div>
4274 <p>&#64;note: isWord('9abc') will return True - not exactly correct, but adequate
4275 for the way it's used here.</p>
4276 <p>&#64;param s: The name to be tested
4277 &#64;type s: any
4278 &#64;return: True if a word, else False
4279 &#64;rtype: bool</p>
4280 </dd></dl>
4281
4282 <dl class="function">
4283 <dt id="src.pyconf.makePath">
4284 <tt class="descclassname">src.pyconf.</tt><tt class="descname">makePath</tt><big>(</big><em>prefix</em>, <em>suffix</em><big>)</big><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>
4285 <dd><p>Make a path from a prefix and suffix.</p>
4286 <p>Examples:
4287 makePath('', 'suffix') -&gt; 'suffix'
4288 makePath('prefix', 'suffix') -&gt; 'prefix.suffix'
4289 makePath('prefix', '[1]') -&gt; 'prefix[1]'</p>
4290 <p>&#64;param prefix: The prefix to use. If it evaluates as false, the suffix is returned.
4291 &#64;type prefix: str
4292 &#64;param suffix: The suffix to use. It is either an identifier or an index in brackets.
4293 &#64;type suffix: str
4294 &#64;return: The path concatenation of prefix and suffix, with adot if the suffix is not a bracketed index.
4295 &#64;rtype: str</p>
4296 </dd></dl>
4297
4298 <dl class="function">
4299 <dt id="src.pyconf.overwriteMergeResolve">
4300 <tt class="descclassname">src.pyconf.</tt><tt class="descname">overwriteMergeResolve</tt><big>(</big><em>map1</em>, <em>map2</em>, <em>key</em><big>)</big><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>
4301 <dd><p>An overwriting resolver for merge conflicts. Calls L{defaultMergeResolve},
4302 but where a &quot;mismatch&quot; is detected, returns &quot;overwrite&quot; instead.</p>
4303 <p>&#64;param map1: The map being merged into.
4304 &#64;type map1: L{Mapping}.
4305 &#64;param map2: The map being used as the merge operand.
4306 &#64;type map2: L{Mapping}.
4307 &#64;param key: The key in map2 (which also exists in map1).
4308 &#64;type key: str</p>
4309 </dd></dl>
4310
4311 </div>
4312 <div class="section" id="module-src.system">
4313 <span id="system-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">system</span></tt> Module<a class="headerlink" href="#module-src.system" title="Permalink to this headline">¶</a></h2>
4314 <p>In this file : all functions that do a system call,
4315 like open a browser or an editor, or call a git command</p>
4316 <dl class="function">
4317 <dt id="src.system.archive_extract">
4318 <tt class="descclassname">src.system.</tt><tt class="descname">archive_extract</tt><big>(</big><em>from_what</em>, <em>where</em>, <em>logger</em><big>)</big><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>
4319 <dd><p>Extracts sources from an archive.</p>
4320 <table class="docutils field-list" frame="void" rules="none">
4321 <col class="field-name" />
4322 <col class="field-body" />
4323 <tbody valign="top">
4324 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
4325 <li><strong>str</strong> (<em>where</em>) -- The path to the archive.</li>
4326 <li><strong>str</strong> -- The path where to extract.</li>
4327 <li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to use.</li>
4328 </ul>
4329 </td>
4330 </tr>
4331 <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>
4332 </td>
4333 </tr>
4334 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">boolean</p>
4335 </td>
4336 </tr>
4337 </tbody>
4338 </table>
4339 </dd></dl>
4340
4341 <dl class="function">
4342 <dt id="src.system.cvs_extract">
4343 <tt class="descclassname">src.system.</tt><tt class="descname">cvs_extract</tt><big>(</big><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><big>)</big><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>
4344 <dd><p>Extracts sources from a cvs repository.</p>
4345 <table class="docutils field-list" frame="void" rules="none">
4346 <col class="field-name" />
4347 <col class="field-body" />
4348 <tbody valign="top">
4349 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
4350 <li><strong>str</strong> (<em>where</em>) -- The cvs protocol.</li>
4351 <li><strong>str</strong> -- The user to be used.</li>
4352 <li><strong>str</strong> -- The remote cvs server.</li>
4353 <li><strong>str</strong> -- <p>.</p>
4354 </li>
4355 <li><strong>str</strong> -- The tag.</li>
4356 <li><strong>str</strong> -- The product.</li>
4357 <li><strong>str</strong> -- The path where to extract.</li>
4358 <li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to use.</li>
4359 <li><strong>boolean</strong> (<em>checkout</em>) -- If true use checkout cvs.</li>
4360 <li><strong>src.environment.Environ</strong> (<em>environment</em>) -- The environment to source when
4361 extracting.</li>
4362 </ul>
4363 </td>
4364 </tr>
4365 <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>
4366 </td>
4367 </tr>
4368 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">boolean</p>
4369 </td>
4370 </tr>
4371 </tbody>
4372 </table>
4373 </dd></dl>
4374
4375 <dl class="function">
4376 <dt id="src.system.git_extract">
4377 <tt class="descclassname">src.system.</tt><tt class="descname">git_extract</tt><big>(</big><em>from_what</em>, <em>tag</em>, <em>where</em>, <em>logger</em>, <em>environment=None</em><big>)</big><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>
4378 <dd><p>Extracts sources from a git repository.</p>
4379 <table class="docutils field-list" frame="void" rules="none">
4380 <col class="field-name" />
4381 <col class="field-body" />
4382 <tbody valign="top">
4383 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
4384 <li><strong>str</strong> (<em>where</em>) -- The remote git repository.</li>
4385 <li><strong>str</strong> -- The tag.</li>
4386 <li><strong>str</strong> -- The path where to extract.</li>
4387 <li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to use.</li>
4388 <li><strong>src.environment.Environ</strong> (<em>environment</em>) -- The environment to source when
4389 extracting.</li>
4390 </ul>
4391 </td>
4392 </tr>
4393 <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>
4394 </td>
4395 </tr>
4396 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">boolean</p>
4397 </td>
4398 </tr>
4399 </tbody>
4400 </table>
4401 </dd></dl>
4402
4403 <dl class="function">
4404 <dt id="src.system.show_in_editor">
4405 <tt class="descclassname">src.system.</tt><tt class="descname">show_in_editor</tt><big>(</big><em>editor</em>, <em>filePath</em>, <em>logger</em><big>)</big><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>
4406 <dd><p>open filePath using editor.</p>
4407 <table class="docutils field-list" frame="void" rules="none">
4408 <col class="field-name" />
4409 <col class="field-body" />
4410 <tbody valign="top">
4411 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
4412 <li><strong>str</strong> (<em>filePath</em>) -- The editor to use.</li>
4413 <li><strong>str</strong> -- The path to the file to open.</li>
4414 </ul>
4415 </td>
4416 </tr>
4417 </tbody>
4418 </table>
4419 </dd></dl>
4420
4421 <dl class="function">
4422 <dt id="src.system.svn_extract">
4423 <tt class="descclassname">src.system.</tt><tt class="descname">svn_extract</tt><big>(</big><em>user</em>, <em>from_what</em>, <em>tag</em>, <em>where</em>, <em>logger</em>, <em>checkout=False</em>, <em>environment=None</em><big>)</big><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>
4424 <dd><p>Extracts sources from a svn repository.</p>
4425 <table class="docutils field-list" frame="void" rules="none">
4426 <col class="field-name" />
4427 <col class="field-body" />
4428 <tbody valign="top">
4429 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
4430 <li><strong>str</strong> (<em>where</em>) -- The user to be used.</li>
4431 <li><strong>str</strong> -- The remote git repository.</li>
4432 <li><strong>str</strong> -- The tag.</li>
4433 <li><strong>str</strong> -- The path where to extract.</li>
4434 <li><strong>Logger</strong> (<em>logger</em>) -- The logger instance to use.</li>
4435 <li><strong>boolean</strong> (<em>checkout</em>) -- If true use checkout svn.</li>
4436 <li><strong>src.environment.Environ</strong> (<em>environment</em>) -- The environment to source when
4437 extracting.</li>
4438 </ul>
4439 </td>
4440 </tr>
4441 <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>
4442 </td>
4443 </tr>
4444 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">boolean</p>
4445 </td>
4446 </tr>
4447 </tbody>
4448 </table>
4449 </dd></dl>
4450
4451 </div>
4452 <div class="section" id="module-src.template">
4453 <span id="template-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">template</span></tt> Module<a class="headerlink" href="#module-src.template" title="Permalink to this headline">¶</a></h2>
4454 <dl class="class">
4455 <dt id="src.template.MyTemplate">
4456 <em class="property">class </em><tt class="descclassname">src.template.</tt><tt class="descname">MyTemplate</tt><big>(</big><em>template</em><big>)</big><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>
4457 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">string.Template</span></tt></p>
4458 <dl class="attribute">
4459 <dt id="src.template.MyTemplate.delimiter">
4460 <tt class="descname">delimiter</tt><em class="property"> = '\xc2\xa4'</em><a class="headerlink" href="#src.template.MyTemplate.delimiter" title="Permalink to this definition">¶</a></dt>
4461 <dd></dd></dl>
4462
4463 <dl class="attribute">
4464 <dt id="src.template.MyTemplate.pattern">
4465 <tt class="descname">pattern</tt><em class="property"> = &lt;_sre.SRE_Pattern object at 0x24c9d70&gt;</em><a class="headerlink" href="#src.template.MyTemplate.pattern" title="Permalink to this definition">¶</a></dt>
4466 <dd></dd></dl>
4467
4468 </dd></dl>
4469
4470 <dl class="function">
4471 <dt id="src.template.substitute">
4472 <tt class="descclassname">src.template.</tt><tt class="descname">substitute</tt><big>(</big><em>template_file</em>, <em>subst_dic</em><big>)</big><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>
4473 <dd></dd></dl>
4474
4475 </div>
4476 <div class="section" id="module-src.test_module">
4477 <span id="test-module-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">test_module</span></tt> Module<a class="headerlink" href="#module-src.test_module" title="Permalink to this headline">¶</a></h2>
4478 <dl class="class">
4479 <dt id="src.test_module.Test">
4480 <em class="property">class </em><tt class="descclassname">src.test_module.</tt><tt class="descname">Test</tt><big>(</big><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><big>)</big><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>
4481 <dd><dl class="method">
4482 <dt id="src.test_module.Test.generate_launching_commands">
4483 <tt class="descname">generate_launching_commands</tt><big>(</big><big>)</big><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>
4484 <dd></dd></dl>
4485
4486 <dl class="method">
4487 <dt id="src.test_module.Test.generate_script">
4488 <tt class="descname">generate_script</tt><big>(</big><em>listTest</em>, <em>script_path</em>, <em>ignoreList</em><big>)</big><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>
4489 <dd></dd></dl>
4490
4491 <dl class="method">
4492 <dt id="src.test_module.Test.get_test_timeout">
4493 <tt class="descname">get_test_timeout</tt><big>(</big><em>test_name</em>, <em>default_value</em><big>)</big><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>
4494 <dd></dd></dl>
4495
4496 <dl class="method">
4497 <dt id="src.test_module.Test.get_tmp_dir">
4498 <tt class="descname">get_tmp_dir</tt><big>(</big><big>)</big><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>
4499 <dd></dd></dl>
4500
4501 <dl class="method">
4502 <dt id="src.test_module.Test.prepare_testbase">
4503 <tt class="descname">prepare_testbase</tt><big>(</big><em>test_base_name</em><big>)</big><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>
4504 <dd></dd></dl>
4505
4506 <dl class="method">
4507 <dt id="src.test_module.Test.prepare_testbase_from_dir">
4508 <tt class="descname">prepare_testbase_from_dir</tt><big>(</big><em>testbase_name</em>, <em>testbase_dir</em><big>)</big><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>
4509 <dd></dd></dl>
4510
4511 <dl class="method">
4512 <dt id="src.test_module.Test.prepare_testbase_from_git">
4513 <tt class="descname">prepare_testbase_from_git</tt><big>(</big><em>testbase_name</em>, <em>testbase_base</em>, <em>testbase_tag</em><big>)</big><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>
4514 <dd></dd></dl>
4515
4516 <dl class="method">
4517 <dt id="src.test_module.Test.prepare_testbase_from_svn">
4518 <tt class="descname">prepare_testbase_from_svn</tt><big>(</big><em>user</em>, <em>testbase_name</em>, <em>testbase_base</em><big>)</big><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>
4519 <dd></dd></dl>
4520
4521 <dl class="method">
4522 <dt id="src.test_module.Test.read_results">
4523 <tt class="descname">read_results</tt><big>(</big><em>listTest</em>, <em>has_timed_out</em><big>)</big><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>
4524 <dd></dd></dl>
4525
4526 <dl class="method">
4527 <dt id="src.test_module.Test.run_all_tests">
4528 <tt class="descname">run_all_tests</tt><big>(</big><big>)</big><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>
4529 <dd></dd></dl>
4530
4531 <dl class="method">
4532 <dt id="src.test_module.Test.run_grid_tests">
4533 <tt class="descname">run_grid_tests</tt><big>(</big><big>)</big><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>
4534 <dd></dd></dl>
4535
4536 <dl class="method">
4537 <dt id="src.test_module.Test.run_script">
4538 <tt class="descname">run_script</tt><big>(</big><em>script_name</em><big>)</big><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>
4539 <dd></dd></dl>
4540
4541 <dl class="method">
4542 <dt id="src.test_module.Test.run_session_tests">
4543 <tt class="descname">run_session_tests</tt><big>(</big><big>)</big><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>
4544 <dd></dd></dl>
4545
4546 <dl class="method">
4547 <dt id="src.test_module.Test.run_testbase_tests">
4548 <tt class="descname">run_testbase_tests</tt><big>(</big><big>)</big><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>
4549 <dd></dd></dl>
4550
4551 <dl class="method">
4552 <dt id="src.test_module.Test.run_tests">
4553 <tt class="descname">run_tests</tt><big>(</big><em>listTest</em>, <em>ignoreList</em><big>)</big><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>
4554 <dd></dd></dl>
4555
4556 <dl class="method">
4557 <dt id="src.test_module.Test.search_known_errors">
4558 <tt class="descname">search_known_errors</tt><big>(</big><em>status</em>, <em>test_grid</em>, <em>test_session</em>, <em>test</em><big>)</big><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>
4559 <dd></dd></dl>
4560
4561 <dl class="method">
4562 <dt id="src.test_module.Test.write_test_margin">
4563 <tt class="descname">write_test_margin</tt><big>(</big><em>tab</em><big>)</big><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>
4564 <dd></dd></dl>
4565
4566 </dd></dl>
4567
4568 <dl class="function">
4569 <dt id="src.test_module.getTmpDirDEFAULT">
4570 <tt class="descclassname">src.test_module.</tt><tt class="descname">getTmpDirDEFAULT</tt><big>(</big><big>)</big><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>
4571 <dd></dd></dl>
4572
4573 </div>
4574 <div class="section" id="module-src.xmlManager">
4575 <span id="xmlmanager-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">xmlManager</span></tt> Module<a class="headerlink" href="#module-src.xmlManager" title="Permalink to this headline">¶</a></h2>
4576 <dl class="class">
4577 <dt id="src.xmlManager.ReadXmlFile">
4578 <em class="property">class </em><tt class="descclassname">src.xmlManager.</tt><tt class="descname">ReadXmlFile</tt><big>(</big><em>filePath</em><big>)</big><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>
4579 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
4580 <p>Class to manage reading of an xml log file</p>
4581 <dl class="method">
4582 <dt id="src.xmlManager.ReadXmlFile.getRootAttrib">
4583 <tt class="descname">getRootAttrib</tt><big>(</big><big>)</big><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>
4584 <dd><p>Get the attibutes of the self.xmlroot</p>
4585 <table class="docutils field-list" frame="void" rules="none">
4586 <col class="field-name" />
4587 <col class="field-body" />
4588 <tbody valign="top">
4589 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The attributes of the root node</td>
4590 </tr>
4591 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
4592 </tr>
4593 </tbody>
4594 </table>
4595 </dd></dl>
4596
4597 <dl class="method">
4598 <dt id="src.xmlManager.ReadXmlFile.get_attrib">
4599 <tt class="descname">get_attrib</tt><big>(</big><em>node_name</em><big>)</big><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>
4600 <dd><p>Get the attibutes of the node node_name in self.xmlroot</p>
4601 <table class="docutils field-list" frame="void" rules="none">
4602 <col class="field-name" />
4603 <col class="field-body" />
4604 <tbody valign="top">
4605 <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>
4606 </tr>
4607 <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>
4608 </tr>
4609 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
4610 </tr>
4611 </tbody>
4612 </table>
4613 </dd></dl>
4614
4615 <dl class="method">
4616 <dt id="src.xmlManager.ReadXmlFile.get_node_text">
4617 <tt class="descname">get_node_text</tt><big>(</big><em>node</em><big>)</big><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>
4618 <dd><p>Get the text of the first node that has name
4619 that corresponds to the parameter node</p>
4620 <table class="docutils field-list" frame="void" rules="none">
4621 <col class="field-name" />
4622 <col class="field-body" />
4623 <tbody valign="top">
4624 <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>
4625 </tr>
4626 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the text of the first node that has name
4627 that corresponds to the parameter node</td>
4628 </tr>
4629 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
4630 </tr>
4631 </tbody>
4632 </table>
4633 </dd></dl>
4634
4635 </dd></dl>
4636
4637 <dl class="class">
4638 <dt id="src.xmlManager.XmlLogFile">
4639 <em class="property">class </em><tt class="descclassname">src.xmlManager.</tt><tt class="descname">XmlLogFile</tt><big>(</big><em>filePath</em>, <em>rootname</em>, <em>attrib={}</em><big>)</big><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>
4640 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
4641 <p>Class to manage writing in salomeTools xml log file</p>
4642 <dl class="method">
4643 <dt id="src.xmlManager.XmlLogFile.add_simple_node">
4644 <tt class="descname">add_simple_node</tt><big>(</big><em>node_name</em>, <em>text=None</em>, <em>attrib={}</em><big>)</big><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>
4645 <dd><p>Add a node with some attibutes and text to the root node.</p>
4646 <table class="docutils field-list" frame="void" rules="none">
4647 <col class="field-name" />
4648 <col class="field-body" />
4649 <tbody valign="top">
4650 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
4651 <li><strong>str</strong> (<em>text</em>) -- the name of the node to add</li>
4652 <li><strong>str</strong> -- the text of the node</li>
4653 <li><strong>dict</strong> (<em>attrib</em>) -- the dictionary containing the
4654 attribute of the new node</li>
4655 </ul>
4656 </td>
4657 </tr>
4658 </tbody>
4659 </table>
4660 </dd></dl>
4661
4662 <dl class="method">
4663 <dt id="src.xmlManager.XmlLogFile.append_node_attrib">
4664 <tt class="descname">append_node_attrib</tt><big>(</big><em>node_name</em>, <em>attrib</em><big>)</big><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>
4665 <dd><p>Append a new attributes to the node that has node_name as name</p>
4666 <table class="docutils field-list" frame="void" rules="none">
4667 <col class="field-name" />
4668 <col class="field-body" />
4669 <tbody valign="top">
4670 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
4671 <li><strong>str</strong> (<em>node_name</em>) -- The name of the node on which append text</li>
4672 <li><strong>dixt</strong> (<em>attrib</em>) -- The attrib to append</li>
4673 </ul>
4674 </td>
4675 </tr>
4676 </tbody>
4677 </table>
4678 </dd></dl>
4679
4680 <dl class="method">
4681 <dt id="src.xmlManager.XmlLogFile.append_node_text">
4682 <tt class="descname">append_node_text</tt><big>(</big><em>node_name</em>, <em>text</em><big>)</big><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>
4683 <dd><p>Append a new text to the node that has node_name as name</p>
4684 <table class="docutils field-list" frame="void" rules="none">
4685 <col class="field-name" />
4686 <col class="field-body" />
4687 <tbody valign="top">
4688 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
4689 <li><strong>str</strong> (<em>text</em>) -- The name of the node on which append text</li>
4690 <li><strong>str</strong> -- The text to append</li>
4691 </ul>
4692 </td>
4693 </tr>
4694 </tbody>
4695 </table>
4696 </dd></dl>
4697
4698 <dl class="method">
4699 <dt id="src.xmlManager.XmlLogFile.write_tree">
4700 <tt class="descname">write_tree</tt><big>(</big><em>stylesheet=None</em>, <em>file_path=None</em><big>)</big><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>
4701 <dd><p>Write the xml tree in the log file path. Add the stylesheet if asked.</p>
4702 <table class="docutils field-list" frame="void" rules="none">
4703 <col class="field-name" />
4704 <col class="field-body" />
4705 <tbody valign="top">
4706 <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>
4707 </tr>
4708 </tbody>
4709 </table>
4710 </dd></dl>
4711
4712 </dd></dl>
4713
4714 <dl class="function">
4715 <dt id="src.xmlManager.add_simple_node">
4716 <tt class="descclassname">src.xmlManager.</tt><tt class="descname">add_simple_node</tt><big>(</big><em>root_node</em>, <em>node_name</em>, <em>text=None</em>, <em>attrib={}</em><big>)</big><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>
4717 <dd><p>Add a node with some attibutes and text to the root node.</p>
4718 <table class="docutils field-list" frame="void" rules="none">
4719 <col class="field-name" />
4720 <col class="field-body" />
4721 <tbody valign="top">
4722 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
4723 <li><strong>etree.Element</strong> (<em>root_node</em>) -- the Etree element where to add the new node</li>
4724 <li><strong>str</strong> (<em>text</em>) -- the name of the node to add</li>
4725 <li><strong>str</strong> -- the text of the node</li>
4726 <li><strong>dict</strong> (<em>attrib</em>) -- the dictionary containing the
4727 attribute of the new node</li>
4728 </ul>
4729 </td>
4730 </tr>
4731 </tbody>
4732 </table>
4733 </dd></dl>
4734
4735 <dl class="function">
4736 <dt id="src.xmlManager.append_node_attrib">
4737 <tt class="descclassname">src.xmlManager.</tt><tt class="descname">append_node_attrib</tt><big>(</big><em>root_node</em>, <em>attrib</em><big>)</big><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>
4738 <dd><p>Append a new attributes to the node that has node_name as name</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"><ul class="first last simple">
4744 <li><strong>etree.Element</strong> (<em>root_node</em>) -- the Etree element
4745 where to append the new attibutes</li>
4746 <li><strong>dixt</strong> (<em>attrib</em>) -- The attrib to append</li>
4747 </ul>
4748 </td>
4749 </tr>
4750 </tbody>
4751 </table>
4752 </dd></dl>
4753
4754 <dl class="function">
4755 <dt id="src.xmlManager.find_node_by_attrib">
4756 <tt class="descclassname">src.xmlManager.</tt><tt class="descname">find_node_by_attrib</tt><big>(</big><em>xmlroot</em>, <em>name_node</em>, <em>key</em>, <em>value</em><big>)</big><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>
4757 <dd><p>Find the nfirst ode from xmlroot that has name name_node and that has in
4758 its attributes {key : value}. Return the node</p>
4759 <table class="docutils field-list" frame="void" rules="none">
4760 <col class="field-name" />
4761 <col class="field-body" />
4762 <tbody valign="top">
4763 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
4764 <li><strong>etree.Element</strong> (<em>xmlroot</em>) -- the Etree element where to search</li>
4765 <li><strong>str</strong> (<em>value</em>) -- the name of node to search</li>
4766 <li><strong>str</strong> -- the key to search</li>
4767 <li><strong>str</strong> -- the value to search</li>
4768 </ul>
4769 </td>
4770 </tr>
4771 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the found node</p>
4772 </td>
4773 </tr>
4774 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">xmlroot etree.Element</p>
4775 </td>
4776 </tr>
4777 </tbody>
4778 </table>
4779 </dd></dl>
4780
4781 <dl class="function">
4782 <dt id="src.xmlManager.write_report">
4783 <tt class="descclassname">src.xmlManager.</tt><tt class="descname">write_report</tt><big>(</big><em>filename</em>, <em>xmlroot</em>, <em>stylesheet</em><big>)</big><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>
4784 <dd><p>Writes a report file from a XML tree.</p>
4785 <table class="docutils field-list" frame="void" rules="none">
4786 <col class="field-name" />
4787 <col class="field-body" />
4788 <tbody valign="top">
4789 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
4790 <li><strong>str</strong> (<em>stylesheet</em>) -- The path to the file to create</li>
4791 <li><strong>etree.Element</strong> (<em>xmlroot</em>) -- the Etree element to write to the file</li>
4792 <li><strong>str</strong> -- The stylesheet to add to the begin of the file</li>
4793 </ul>
4794 </td>
4795 </tr>
4796 </tbody>
4797 </table>
4798 </dd></dl>
4799
4800 </div>
4801 <div class="section" id="subpackages">
4802 <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
4803 <div class="toctree-wrapper compound">
4804 <ul>
4805 <li class="toctree-l1"><a class="reference internal" href="src.colorama.html">colorama Package</a><ul>
4806 <li class="toctree-l2"><a class="reference internal" href="src.colorama.html#id1"><tt class="docutils literal"><span class="pre">colorama</span></tt> Package</a></li>
4807 <li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.ansi"><tt class="docutils literal"><span class="pre">ansi</span></tt> Module</a></li>
4808 <li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.ansitowin32"><tt class="docutils literal"><span class="pre">ansitowin32</span></tt> Module</a></li>
4809 <li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.initialise"><tt class="docutils literal"><span class="pre">initialise</span></tt> Module</a></li>
4810 <li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.win32"><tt class="docutils literal"><span class="pre">win32</span></tt> Module</a></li>
4811 <li class="toctree-l2"><a class="reference internal" href="src.colorama.html#module-src.colorama.winterm"><tt class="docutils literal"><span class="pre">winterm</span></tt> Module</a></li>
4812 </ul>
4813 </li>
4814 </ul>
4815 </div>
4816 </div>
4817 </div>
4818
4819
4820           </div>
4821         </div>
4822       </div>
4823       <div class="sphinxsidebar">
4824         <div class="sphinxsidebarwrapper">
4825             <p class="logo"><a href="../../index.html">
4826               <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
4827             </a></p>
4828   <h3><a href="../../index.html">Table Of Contents</a></h3>
4829   <ul>
4830 <li><a class="reference internal" href="#">src Package</a><ul>
4831 <li><a class="reference internal" href="#id1"><tt class="docutils literal"><span class="pre">src</span></tt> Package</a></li>
4832 <li><a class="reference internal" href="#module-src.ElementTree"><tt class="docutils literal"><span class="pre">ElementTree</span></tt> Module</a></li>
4833 <li><a class="reference internal" href="#module-src.architecture"><tt class="docutils literal"><span class="pre">architecture</span></tt> Module</a></li>
4834 <li><a class="reference internal" href="#module-src.compilation"><tt class="docutils literal"><span class="pre">compilation</span></tt> Module</a></li>
4835 <li><a class="reference internal" href="#module-src.debug"><tt class="docutils literal"><span class="pre">debug</span></tt> Module</a></li>
4836 <li><a class="reference internal" href="#module-src.environment"><tt class="docutils literal"><span class="pre">environment</span></tt> Module</a></li>
4837 <li><a class="reference internal" href="#module-src.fileEnviron"><tt class="docutils literal"><span class="pre">fileEnviron</span></tt> Module</a></li>
4838 <li><a class="reference internal" href="#module-src.fork"><tt class="docutils literal"><span class="pre">fork</span></tt> Module</a></li>
4839 <li><a class="reference internal" href="#module-src.logger"><tt class="docutils literal"><span class="pre">logger</span></tt> Module</a></li>
4840 <li><a class="reference internal" href="#module-src.options"><tt class="docutils literal"><span class="pre">options</span></tt> Module</a></li>
4841 <li><a class="reference internal" href="#module-src.printcolors"><tt class="docutils literal"><span class="pre">printcolors</span></tt> Module</a></li>
4842 <li><a class="reference internal" href="#module-src.product"><tt class="docutils literal"><span class="pre">product</span></tt> Module</a></li>
4843 <li><a class="reference internal" href="#module-src.pyconf"><tt class="docutils literal"><span class="pre">pyconf</span></tt> Module</a></li>
4844 <li><a class="reference internal" href="#module-src.system"><tt class="docutils literal"><span class="pre">system</span></tt> Module</a></li>
4845 <li><a class="reference internal" href="#module-src.template"><tt class="docutils literal"><span class="pre">template</span></tt> Module</a></li>
4846 <li><a class="reference internal" href="#module-src.test_module"><tt class="docutils literal"><span class="pre">test_module</span></tt> Module</a></li>
4847 <li><a class="reference internal" href="#module-src.xmlManager"><tt class="docutils literal"><span class="pre">xmlManager</span></tt> Module</a></li>
4848 <li><a class="reference internal" href="#subpackages">Subpackages</a><ul>
4849 </ul>
4850 </li>
4851 </ul>
4852 </li>
4853 </ul>
4854 <div class="relations">
4855 <h3>Related Topics</h3>
4856 <ul>
4857   <li><a href="../../index.html">Documentation overview</a><ul>
4858   <li><a href="modules.html">src</a><ul>
4859       <li>Previous: <a href="modules.html" title="previous chapter">src</a></li>
4860       <li>Next: <a href="src.colorama.html" title="next chapter">colorama Package</a></li>
4861   </ul></li>
4862   </ul></li>
4863 </ul>
4864 </div>
4865   <h3>This Page</h3>
4866   <ul class="this-page-menu">
4867     <li><a href="../../_sources/commands/apidoc/src.txt"
4868            rel="nofollow">Show Source</a></li>
4869   </ul>
4870 <div id="searchbox" style="display: none">
4871   <h3>Quick search</h3>
4872     <form class="search" action="../../search.html" method="get">
4873       <input type="text" name="q" />
4874       <input type="submit" value="Go" />
4875       <input type="hidden" name="check_keywords" value="yes" />
4876       <input type="hidden" name="area" value="default" />
4877     </form>
4878     <p class="searchtip" style="font-size: 90%">
4879     Enter search terms or a module, class or function name.
4880     </p>
4881 </div>
4882 <script type="text/javascript">$('#searchbox').show(0);</script>
4883         </div>
4884       </div>
4885       <div class="clearer"></div>
4886     </div>
4887     <div class="footer">
4888       &copy;2018, CEA.
4889
4890       |
4891       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
4892       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
4893
4894       |
4895       <a href="../../_sources/commands/apidoc/src.txt"
4896           rel="nofollow">Page source</a>
4897     </div>
4898
4899
4900
4901
4902   </body>
4903 </html>